PIpinterest
msot_events

Send Measurement Source Of Truth (MSOT) attributed conversion events

Changed on

This feature is currently in beta and not available to all apps. If you are interested in joining the beta, reach out to your Pinterest account manager.

Advertisers or their measurement partners can send attributed MSOT conversion events to Pinterest based on their ad_account_id. The request body should be a JSON object.

  • These events will not be used in Reporting.
post/ad_accounts/{ad_account_id}/msot/events

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

action_timestampsinteger[]

Timestamp(s) when the ad action(s) happened. Unix timestamp in seconds.

ad_group_idstring required
attribution_model'first_touch' | 'last_touch' | 'multi_touch' | 'mmm'

Attribution model used to attribute the conversion event.

attribution_scope'view' | 'engagement' | 'click'

Ad event type used for attribution.

attribution_scorenumber double

Credit given to the attributed ad actions. Allowed values are > 0 and <= 1.

campaign_idstring
click_windowstring

Click window used for attribution (for example, 1d, 7d, 30d, lifetime).

currency'UNK' | 'USD' | 'GBP' | 'CAD' | 'EUR' | 'AUD' | 'NZD' | 'SEK' | 'ILS' | 'CHF' | 'HKD' | 'JPY' | 'SGD' | 'KRW' | 'NOK' | 'DKK' | 'PLN' | 'RON' | 'HUF' | 'CZK' | 'BRL' | 'MXN' | 'ARS' | 'CLP' | 'COP' | 'INR' | 'TRY'

Currency Codes from ISO 4217

event_idstring required

A unique id string that identifies this event. If you are already sending us events through Conversions API, then this id should match the event_id sent through Conversions API.

event_name'add_to_cart' | 'checkout' | 'lead' | 'signup' required

Type of user conversion event.

event_timestampinteger required

The time when the event occurred. Unix timestamp in seconds.

total_event_touchpointsinteger

Total number of ad events including other non-Pinterest ad platforms.

total_eventsinteger

Deprecated: use total_events_fractional instead to avoid rounding errors. Total number of conversion events that are reported in one API call.

If you are sending one API request for one attributed conversion event then this value should be 1. If you are sending multiple attributed conversion events in one API request then this value should be the total number of attributed conversion events in the request.

total_events_fractionalnumber double

Total number of conversion events that are reported in one API call. Use this field instead of total_events to send precise fractional values.

If you are sending one API request for one attributed conversion event with full credit, this value should be 1.0. For partial attribution, send the exact fractional value (e.g., 0.5 for half credit).

valuenumber double

Order value of the conversion event. Required if event_name is add_to_cart or checkout.

view_windowstring

View window used for attribution (for example, 1d, 7d, 30d).

Example request

{
  "action_timestamps": [
    1451410040
  ],
  "attribution_score": 0.5,
  "event_id": "eventId0001",
  "event_timestamp": 1451431341,
  "total_event_touchpoints": 2,
  "total_events": 2,
  "value": 123.45
}

Response

The request has succeeded.

Changes

  • v5b698c180678aRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value add_to_cart of the request property

    • breaking

      removed the enum value checkout of the request property

    • breaking

      removed the enum value click of the request property

    • breaking

      removed the enum value engagement of the request property

    • breaking

      removed the enum value first_touch of the request property

    • breaking

      removed the enum value last_touch of the request property

    • breaking

      removed the enum value lead of the request property

    • breaking

      removed the enum value multi_touch of the request property

    • breaking

      removed the enum value signup of the request property

    • breaking

      removed the enum value view of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • warning

      removed subschema #2 from the request property allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property deprecated

    • info

      removed the pattern ^\d+$ from the request property

    • info

      removed the pattern ^\d+$ from the request property

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • v510f9eba4ad97Revision changes
    • info

      endpoint added