attribution

Record where a new workspace came from

Record the marketing page or campaign the caller's workspace signed up from: the src tag and the utm_source, utm_medium and utm_campaign values the register link carried. The app sends it once, right after signup. First touch wins: a workspace keeps the first source recorded for it, and one that is no longer registering records nothing. Neither is an error; both report recorded: false. Requires a signed-in user rather than an API key: a signup has a person behind it.

post/attribution/signup-source/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/attribution/signup-source/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

srcstring nullable

The marketing site's own source tag from the register link's src parameter, <lane>-<slug>[-<slot>], for example blog-what-is-data-enrichment-moment.

utm_campaignstring nullable

The register link's utm_campaign parameter, if it had one.

utm_mediumstring nullable

The register link's utm_medium parameter, if it had one.

utm_sourcestring nullable

The register link's utm_source parameter, if it had one.

Response

Successful Response

recordedboolean required

Whether this call recorded the source for the workspace.

Changes

No recorded changes to this operation across all 1 revision of this API.