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:
- The endpoints use the data integration environment.
- When making calls, you can authenticate using a token. 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 28.6 MB. There's no limit on the number of events you can send.
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/thirdparty | Upload and manage third-party data for audience targeting. | No | Third-party audience data integration | You can also use this endpoint to delete user IDs from specific segments. |
| POST /data/deletion-optout/thirdparty | Delete third-party data from 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/advertiser (External Provider) | Upload and manage first-party data on behalf of an advertiser for audience targeting. | No | N/A | This endpoint is intended only for external providers uploading first-party data on behalf of an advertiser and requires your data provider ID in addition to the advertiser ID. |
| POST /data/deletion-optout/advertiser (External Provider) | Delete first-party data from segments for the specified user ID on behalf of an advertiser. | 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 /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. |
| POST /providerapi/offlineconversion | Upload and manage user-level offline conversions, which can include use cases such as attributing in-store sales, place visits, or custom events. | No | Offline conversion events | None. |
| POST /data/deletion-optout/merchant | Delete IDs that were shared with The Trade Desk via a product catalog for the specified merchant 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. |
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.
How can I delete IDs only from specific segments?
If you want to delete IDs only from specific segments, you must use the respective POST /data/thirdparty or POST /data/advertiser (External Provider) data integration endpoint. For example, you can use them to remove inactive users by setting the TTLInMinutes to 0.
Can I use these data integration endpoints to delete IDs from all data segments?
No. These endpoints do 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 respective POST /data/deletion-optout/thirdparty or POST /data/deletion-optout/advertiser (External Provider) ID deletion and opt-out endpoint.
Who can use the ID Deletion and Opt-Out endpoints?
Partners who share their attribution, conversion, and other data with The Trade Desk. For example, third-party audience providers, measurement providers, and merchants.