conversions

Identify a visitor

Changed on

Records who a visitor is (by email, phone or your own id, all hashed at rest) together with the ad click id that brought them, so that a conversion reported later by email alone can still be credited to the click. Where the click id is gone, the identity itself is used for Enhanced Conversions for Leads.

Also accepted with the campaigns:write scope, and with a website key (grow_pub_…), which is the credential the site tag carries. A personal token still works for server-to-server callers.

Errors

  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
post/api/v1/identify

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/identify
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

emailstring

The visitor's email. Hashed at rest and used for identity matching.

externalIdstring

Your own id for the visitor, for example a CRM or customer id.

phonestring

Phone number in E.164 format. Hashed at rest.

msclkidstring

Microsoft Advertising click id.

gclidstring

Google Ads click id.

gbraidstring

Google Ads click id for app campaigns on iOS.

wbraidstring

Google Ads click id for web campaigns on iOS.

rdt_cidstring

Reddit Ads click id.

fbclidstring

Meta click id.

opprefstring

ChatGPT Ads click id.

li_fat_idstring

LinkedIn Ads click id.

clickIdstring

A click id when you do not know which kind it is; set clickIdType with it.

clickIdType'msclkid' | 'gclid' | 'gbraid' | 'wbraid' | 'rdt_cid' | 'fbclid' | 'oppref' | 'li_fat_id'

Which kind of click id clickId is.

landingUrlstring

The page the visitor landed on.

clickedAtstring date-time

When the CLICK happened, as observed at landing — not when this beacon was sent. Meta derives fbc from it. Ignored if unparseable or in the future; defaults to arrival time.

utmobject

UTM parameters from the landing URL.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

  • f02611b531aaRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new fbclid enum value to the request property

    • info

      added the new li_fat_id enum value to the request property

    • info

      added the new oppref enum value to the request property

    • info

      added the new rdt_cid enum value to the request property