Data API
The Data API suite consists of several endpoints that are intended for uploading and managing your data in The Trade Desk platform. Here's what you need to know about these endpoints:
- These endpoints use the data integration environment.
- To use these endpoints, you must authenticate using a token and choose the appropriate data center that stores your data. For details, see Making calls.
- The endpoints support a variety of ID types, including TDID, DAID, RampID, IP addresses, and unified IDs (UID2 or EUID).
- After the data is uploaded to The Trade Desk platform, the Platform API endpoints are used to manage audience segments, as noted in the respective usage guides.
NOTE: More than one version of the Data API is available. We recommend the latest, version 2, which has improved error handling and other updates.
Request size limits
The total request size may not exceed 2.5 MB, which is approximately 10,000 IDs.
TIP: To upload a larger file, split it into several smaller files that meet the request size requirements. For details, see the individual endpoints.
Endpoint reference
The following table lists the Data endpoints along with relevant usage details.
| Endpoint | Description | Permission Required? | Usage Guide | Notes |
|---|---|---|---|---|
| POST /data/advertiser | Upload and manage first-party data for audience targeting. | No | Anonymous ID data integration | You can also use this endpoint to delete user IDs from specific segments. |
| POST /data/deletion-optout/advertiser | Delete data across all of your segments for the specified user ID. | No | N/A | IMPORTANT: Once removed or opted out, IDs cannot be recovered. Ensure that you specify the correct IDs in your requests, as data restoration will not be possible. |
| POST /data/firstpartyipaddress | Upload and manage first-party IP addresses for audience targeting. | Permissions required | First-party IP address data integration | To request access to this endpoint, contact your Technical Account Manager. |
| POST /providerapi/offlineconversion | Upload and manage user-level offline conversions, which can include use cases such as attributing in-store sales, place visits, merchant product catalog items, or custom events. | No | Offline conversion events | None. |
| POST /track/realtimeconversion | Upload user-level online conversion events in real-time, which can include use cases such as retargeting and attribution for cart-level data. | No | Real-time conversion events | This endpoint does not require authentication. |
Rate limits
Rate limiting for the data integration environment uses a similar framework to the Platform API. For details, see Rate limits.
Error handling
For a list of error codes and messages, refer to the individual endpoints.
TIP: When creating your automation with our API, design your workflow so that you pause your automation and notify stakeholders when 400-level and 500-level status codes are received.
FAQs
The following is a list of commonly asked questions about the Data API:
How do I manage my data rates or create audiences with my data?
To manage your taxonomy, data rates, or to create data groups for audiences, use the respective Platform API suites. For example, see Audience.
How can I delete IDs only from specific segments?
If you want to delete IDs only from specific segments, you must use the POST /data/advertiser endpoint. For example, you can use it to remove inactive users by setting the TTLInMinutes to 0.
Can I use the POST /data/advertiser to delete IDs from all data segments?
No. The POST /data/advertiser endpoint does not have the capability to delete IDs across your segments. If you are looking to support opt-out or deletion requests and want to delete the user from your segments, you must use the POST /data/deletion-optout/advertiser endpoint. It will delete specified IDs from your segments associated with the respective partner account.
Who can use the ID Deletion and Opt-Out endpoint?
Partners who share their attribution, conversion, and other data with The Trade Desk.
How do I authenticate for uploading real-time conversion event data?
The POST /track/realtimeconversion endpoint does not require authentication.