Get Started
Integration Steps
Following are the high-level steps for setting up a Conversions API integration:
- Choosing suitable integration method.
- Ensuring necessary prerequisites/requirements are in place for the chosen implementation method.
- Implementation
- Verifying your CAPI setup and adhering to best practices guidelines.
Integration Techniques
There are 2 ways to integrate with CAPI:
- Direct Integration - For the most control over your integration process, we recommend building a direct integration with the Conversions API. This requires developer-involvement. We also offer a Java Business SDK to streamline the setup and integration process.
- Partner Integration - If you are already working with one of Snap’s partner platforms you may be able to set up the Conversions API through a partner integration without needing developer involvement. Learn more about our partner integrations here.
This rest of this document focuses on direct implementation.
Requirements
Pixel ID or Snap App ID
Depending on the type of events you will be reporting to Snap, you will need to set up and use either a Pixel ID or a Snap App ID. The ID you use for your events also decides the parameters you should be passing when you send events.
This table outlines the parameters you should be passing with your events.
Property | ID | Description |
---|---|---|
Website | pixel_id | Events taking place on a web property. If you are passing the same events via a Pixel on your website, you should use the pixel_id to ensure all events are entering the same pipeline for deduplication. |
Mobile App | snap_app_id | Events taking place within an App |
Offline | pixel_id | Measure events that take place in-store, over the phone or online (but are not pixelable). |
Business Manager
You will need a Business Manager to use the Conversions API. Business Manager helps advertisers integrate Snapchat's marketing efforts across their business and with external partners. See the Help Center article on how to Create a Business Manager if you don't have one.
Access Token
We recommend that you use static long-lived tokens generated on the Business Details page of Ads Manager to make a Conversions API call. To do this, you’ll need to be an Organization Admin to see the dashboard and follow the below steps:
Static Long Lived Tokens
- Log in to Ads Manager . Then click the menu in the top corner and select Business Details.
- Once on this page, under the OAuth Apps section, you will now see a new section called the Conversions API Tokens. Here you can click on the Generate Token button to generate a new token. Please note that you must be a Organization Admin to view this section of the page.
- You can then copy the token and use it in the v3 endpoint
- You may generate multiple tokens and can also delete these tokens to invalidate them. These tokenAds do not expire and you do not need to refresh access.
- You may make as many requests as needed. If you are using a Long Lived Token, we recommend a 1000 QPS limit for sending us requests. You may send up to 2000 events per batch request, and can thus send up to 2M events/sec.
- You can only send events for the pixel and app IDs that belong to the Org where the token has been generated. For example: If your token belongs to Org1 and Pixel ID to Org2. Any API requests using this token from Org1 for the pixel ID from Org2 will fail.
Rate Limiting Please note that the standard API Rate Limits of 10 req/sec apply. You may send up to 2,000 events per batch request and can thus send up to 20,000 req/sec.