RudderStack Tracking Plan API Deprecated
3 minute read
This API is deprecated. See Data Catalog API to create and manage your Tracking Plans programmatically.
The Tracking plan API lets you programmatically create and manage your Tracking Plans. You can use the API to:
- Create/update/fetch Tracking Plans associated with your workspace
- Define Tracking Plan rules
- Create/update Tracking Plan configurations for a particular source
- Link and unlink a source/events to a Tracking Plan
- Delete a Tracking Plan
Prerequisites
- Set up a source-destination connection in RudderStack. See the Quickstart guide for detailed steps.
- Generate a workspace-level Service Access Token in the RudderStack dashboard with Admin permissions to authenticate the API.
API authorization
The Tracking Plan API uses Basic Authentication for authenticating all requests.
If you’re using Postman, authenticate the API by including an empty string ("") as the username and your workspace-level Service Access Token as the password in the Authorization tab.
You can also pass your Service Access Token in the authorization header directly:
Authorization: Basic {Base64Encoded(:<SERVICE_ACCESS_TOKEN>)}An example is shown below:
- Username:
""(empty string) - Service Access Token:
<SERVICE_ACCESS_TOKEN> - Header:
Basic {Base64Encoded(:<SERVICE_ACCESS_TOKEN>)}
Verify that the Service Access Token is valid if you get an Invalid Authorization Header error.
Base URL
Use the base URL for your API requests depending on your region:
https://api.rudderstack.comhttps://api.eu.rudderstack.comTracking plan API usage
| Tracking plan API | Description |
|---|---|
| Tracking Plans | This section contains all the requests and the examples related to:
|
| Tracking Plan Rules | This section contains all the requests and the examples related to setting the Tracking Plan rules like:
identify, group, page, and screen events) like:
|
| Source Tracking Plan Connections | This section contains all the requests and the examples related to Tracking Plan configurations like:
|
Event structure
To perform the Tracking Plan validation successfully, your event payload structure must conform to the standard RudderStack event spec.
See the following sample event payloads for more information:
You can also see the example request in the Create Tracking Plan API for the event formatting structure.
