Send conversion events to the Pinterest API for Conversions
POST {{baseUrl}}/ad_accounts/:ad_account_id/events?test=true
The Pinterest API offers advertisers a way to send Pinterest their conversion information (including web conversions, in-app conversions, or even offline conversions) based on their adaccountid. The request body should be a JSON object.
- This endpoint requires an accesstoken be generated through Ads Manager. Review the Conversions Guide for more details.
- The token's useraccount must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Audience, Campaign.
- If the merchant is submitting this information using both Pinterest conversion tags and the Pinterest API, Pinterest will remove duplicate information before reporting. (Note that events that took place offline cannot be deduplicated.)
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
test | boolean | Include query param ?test=true to mark the request as a test request. The events will not be recorded but the API will still return the same response messages. Use this mode to verify your requests are working and your events are constructed correctly. | |
| Warning: If you use this query parameter, be certain that it is off (set to false or deleted) before sending a legitimate (non-testing) request. |
Request Body
{"data"=>[{"event_name"=>"checkout", "action_source"=>"app_ios", "event_time"=>1451431341, "user_data"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event_id"=>"eventId0001", "event_source_url"=>"https://example.org/", "opt_out"=>false, "partner_name"=>"ss-companyname", "custom_data"=>{"currency"=>"USD", "value"=>"425325.89", "content_ids"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "contents"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}], "num_items"=>13345695, "order_id"=>"officia pariatur nisi dolor", "search_string"=>"irur", "opt_out_type"=>"LDP", "np"=>"tempor nulla mi"}, "app_id"=>"culpa velit et", "app_name"=>"consequat ut reprehenderit nisi", "app_version"=>"Duis ipsum dolore tempor", "device_brand"=>"Duis", "device_carrier"=>"volupt", "device_model"=>"consectetur aute", "device_type"=>"labore esse", "os_version"=>"esse in sint", "wifi"=>false, "language"=>"en"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"num_events_received":-60096561,"num_events_processed":23923485,"events":[{"status":"processed","error_message":"in dolore","warning_message":"elit consequat dolor"},{"status":"processed","error_message":"ut Excepteur exercitation occaecat","warning_message":"proident"}]}