conversions

Create a conversion action

Creates the action locally. A sync exports it to the platforms, which assign the remote id and the tag snippet; a client cannot set the platform link itself.

Errors

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

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/conversion-actions
  • Auth: 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

namestring required

Display name, also accepted wherever a conversion action is referenced by name.

type'WEBPAGE' | 'AD_CALL' | 'WEBSITE_CALL' | 'UPLOAD_CLICKS' | 'UPLOAD_CALLS' required

Where the conversion is observed. UPLOAD_CLICKS and UPLOAD_CALLS are the types for conversions you report through this API.

category'PURCHASE' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'SUBMIT_LEAD_FORM' | 'SIGNUP' | 'CONTACT' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'PAGE_VIEW' | 'DOWNLOAD' | 'PHONE_CALL_LEAD' | 'ENGAGEMENT' | 'DEFAULT' required

What kind of outcome this is, as the platforms classify it.

status'ENABLED' | 'PAUSED'

A paused action records nothing.

countingType'ONE_PER_CLICK' | 'MANY_PER_CLICK'

ONE_PER_CLICK for leads and sign-ups, MANY_PER_CLICK for purchases.

clickThroughLookbackWindowDaysinteger

How many days after a click a conversion still counts. Capped at 30 by the platform for all types except calls, where 60 is allowed.

viewThroughLookbackWindowDaysinteger

How many days after an ad view (without a click) a conversion still counts.

attributionModel'DATA_DRIVEN' | 'LAST_CLICK'

How credit is split across the clicks before a conversion.

enhancedConversionsForLeadsboolean

Enable Enhanced Conversions for Leads, so uploads that carry only a hashed email or phone can still be matched after the click id is gone.

leadStage'signup' | 'trial_started' | 'qualified_lead' | 'paid' | 'expansion'

The funnel stage this action represents. Events reported with this event name land here.

defaultEventValuenumber

Value assigned to an event that arrives without one.

includeInConversionsMetricboolean

Whether the platform counts this action in its headline conversions number and optimises bidding for it.

Response

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

dataunknown required

Changes

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