![](\"https://user-images.githubusercontent.com/59817155/132644830-6542369b-94ae-4af6-b3bb-c1432e64cd2c.png\")
Detailed documentation of all the supported RudderStack APIs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16242548","collectionId":"088459e3-cfdf-4bf4-81db-58b4dae7bc3b","publishedId":"TzeWFT6D","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"10174C"},"publishDate":"2021-06-16T05:33:33.000Z"},"item":[{"name":"HTTP API","item":[{"name":"Identify","id":"87ff0af0-3a0e-4fff-81f3-76f7daf256b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"userId\": \"user1\",\n \"anonymousId\":\"anon-id-new\",\n \"context\": {\n \"traits\": {\n \"trait1\": \"new-val\" \n },\n \"ip\": \"14.5.67.21\",\n \"library\": {\n \"name\": \"http\"\n }\n },\n \"timestamp\": \"2020-02-02T00:23:09.544Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{data_plane_url}}/v1/identify","description":"The identify call lets you capture the relevant details about a visitor user and also record any traits associated with them.
\n\nAs a best practice, make sure the
\nidentifycall is made at the start of every session or page load for logged-in users. This will ensure all the latest user traits are captured.
The track call lets you record all the user actions along with their associated properties.
\n\nEach user action is considered to be an event.
\n
The page call lets you record your website's page views along with any additional relevant information about the viewed page.
The screen call lets you record whenever a mobile app user sees the screen of their mobile device. This call is the page equivalent for a mobile app/device.
The group call lets you associate an identified user with a group such as a company, organization, or an account.
It also allows you to record any traits associated with that group such as the name of the company, industry, or the number of employees in the organization.
\nThe alias call captures any relevant details about the user's alternate/past identity. With alias, you can merge or associate a user's past identity with the current one.
The alias call is quite useful in cases where you need to associate an anonymousId with an identified user on signup (in case of Mixpanel) or associating user identities when the user switches their IDs (in case of Kissmetrics).
The batch call lets you send a series of identify, track, page, group, and screen requests in a single batch. This call helps you minimize the number of outbound requests, thus enabling better performance.
\n\nRudderStack sets a maximum limit of 4 MB per batch request and 32 KB per call.
\n
\n\nThe
\ncontextandintegrationsfields in thebatchcall are the same as in case of other calls. However, they are merged with thecontextorintegrations(if any) fields in each of the calls included withinbatch.
The RudderStack HTTP API lets you track your customer event data and route it to your desired destinations.
\n\n\nWe recommend using the RudderStack SDKs for automatic tagging of the user identity as well as context, batching the events, and leveraging the retry functionality in case of failure. However, if you cannot use our SDKs, it is possible to send your event data using the HTTP API.
\n
To send HTTP requests, you should have a RudderStack server configured with your workspace token. Please refer to this section for installing and setting up RudderStack.
\n\n\nFor more information on the RudderStack Data Plane, refer to our documentation.
\n
\n\nNote: RudderStack's HTTP server should be accessible from your HTTP client.
\n
\n\nA workspace token is unique to your RudderStack workspace.
\n
![](\"https://user-images.githubusercontent.com/59817155/126443739-c79ba47e-e0f9-4f2e-9ebb-f03d6042e94a.png\")
\n\nImport the Postman collection using this URL and edit the variables source_write_key and data_plane_url with your source write key and the RudderStack Data Plane URL. Now you can test all supported requests.
\n\nNote: If you are using RudderStack Cloud, the Data Plane URL should be set to: https://hosted.rudderlabs.com.
\n
RudderStack uses Basic Authentication for authenticating all the HTTP requests. The HTTP Basic Authentication requires a username and password, where:
\n\" \") is the password.A source write key is the write key associated with the source you have configured in RudderStack, as shown:
\nFor example, if your writeKey is 1Xk5DChfJAol3xtW7qNnK1apo5p, then your HTTP request must have the following HTTP header:
Authorization: Basic MVhrNURDaGZKQW9sM3h0VzdxTm5LMWFwbzVwOg==
You can refer to this sample Basic Auth header generator to verify your header.
\nRudderStack returns a 200 response for successful API requests. It returns a 400 response for invalid requests along with an appropriate error message in the response.
Some responses to the invalid requests include:
\nRudderStack allows a maximum of 32KB message size per call, while the batch API request allows a maximum call size of 4MB. If these limits are exceeded, RudderStack responds with a 400 Bad Request response.
To maintain event ordering while using the HTTP API, make sure to include anonymousId as a header in every request.
RudderStack lets you import any historical data by adding the timestamp argument to any of your API calls. However, this can be done only for the destinations that accept historical timestamped data, like Amplitude, Mixpanel, etc.
\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{source_write_key}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e86eb016-3d7f-4cd5-b89b-8abe1eee7f4d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"83cd1ee3-2df2-44e4-97e1-9fbf5f6e7f7c","type":"text/javascript","exec":[""]}}],"_postman_id":"ef04bfe0-57e0-4138-88e7-782594888189"},{"name":"Access Tokens","item":[],"id":"2386c39c-8faf-4db2-ad00-3d0917cc2d04","description":"If you are tracking current events, leave out the timestamp field. RudderStack automatically adds the timestamps to the event requests.
\n
To consume all the public RudderStack APIs, you will need access to them. This guide details the steps required to generate an access token and the operations associated with it.
\n\n\nRead more about RudderStack's Transformations feature here.
\n
The RudderStack Cloud users who have the Read/Write or Admin privileges can create their own access tokens and use them.
\nTo use all the public RudderStack APIs, you can create your own Access Token by following the steps below:
\n
![](\"https://user-images.githubusercontent.com/59817155/132644851-12db3095-6ea5-423f-aa0c-5890f8d0e62f.png\")
![](\"https://user-images.githubusercontent.com/59817155/132644881-879f4b14-064b-4168-9e52-69707480926e.png\")
\n\nMake sure you copy the generated token. You won't be able to see it again.
\n
![](\"https://user-images.githubusercontent.com/59817155/132644930-ce2124ac-897c-44d5-b51e-8201e03c1a6c.png\")
For any queries on generating or using the access tokens to consume the RudderStack APIs, you can start a conversation on our Slack channel.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"06fa6470-ce02-483f-b322-e934a595f3f4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb30fc1c-f560-4f16-8710-f0b5753dd8da","type":"text/javascript","exec":[""]}}],"_postman_id":"2386c39c-8faf-4db2-ad00-3d0917cc2d04"},{"name":"Transformations API","item":[{"name":"Transformations","item":[{"name":"Create a Transformation","id":"30b5b2e2-9868-4558-9280-41d6e1acaee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Transformation JS 1\",\n \"description\": \"Sample transformation\",\n \"code\": \"export function transformEvent(event) { return event; }\",\n \"language\": \"javascript\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/transformations","description":"This request creates a transformation and gets its object as a response.
\nThe following table highlights the query parameters when making the API request.
\nThe following table highlights the different body parameters when making the API request.
\nYou can create a transformation in one of the following ways:
\npublish: true - In this case, RudderStack maintains two copies of the transformation. Among these, one is published and the other is used for revisions. You can connect the published transformation to a destination and its code is made live for incoming traffic.publish: false - In this case, RudderStack only creates revisions for the transformation. This means that you cannot connect any destinations to the transformation and it cannot be used for any incoming event traffic.\n\nNote: If you wish to publish some revisions of transformations you can do so using the Publish API (refer below).
\n
This request creates and publishes a transformation.
\nYou can create a transformation in one of the following ways:
\npublish: true - In this case, RudderStack maintains two copies of the transformer. Among these, one is published and the other is used for revisions. You can connect the published version to a destination and its code is made live for incoming traffic.
publish: false - In this case, RudderStack only creates revisions for the transformation. This means that you cannot connect any destinations to the transformation and it cannot be used for any incoming event traffic.
This request gets all the published transformations for a particular workspace.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}},"urlObject":{"path":["transformations"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"607314d2-ca2d-4295-a0bd-c129ac573b82","name":"List All Transformations","originalRequest":{"method":"GET","header":[],"url":"https://api.rudderstack.com/transformations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"348"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:33:58 GMT"},{"key":"X-Request-ID","value":"cbe9f010-b928-11ed-85e5-930703c0462f"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"GnJas4xr2B-mgKTi8UcmyzO-89mI7IHSRWZIDHe60KtunJE29SKhcQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"transformations\": [\n {\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTAtB7m8oR7zLyBJS0QWkuUY93\",\n \"name\": \"Transformation JS 2\",\n \"description\": \"\",\n \"code\": \"export function transformEvent(event) { return event; }\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\",\n \"destinations\": []\n },\n {\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTC30bbSUANEeLb7TeknDbBeFy\",\n \"name\": \"Transformation PY 2\",\n \"description\": \"\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\",\n \"destinations\": []\n }\n ]\n}"}],"_postman_id":"4eecdd72-0811-4f17-99e1-00b2339c9901"},{"name":"Retrieve a Single Transformation","id":"ba1b7fe2-7758-4bba-9d2e-9a6c2ef5a95b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/transformations/{{id}}","description":"This request retrieves the published transformations from the specified transformation id.
This request updates a transformation by creating a new revision. If the publish flag is set is true, the code becomes live for the event traffic. If the publish flag is false , it only creates a new revision for that transformation without publishing it.
\n\nNote: Language cannot be updated i.e. javascript transformation cannot be converted to python or vice versa
\n
The following table highlights the different body parameters when making this API request.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}},"urlObject":{"path":["transformations","{{id}}"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"21dd84a2-0658-41eb-b025-92b130809ba2","name":"Update a Transformation JS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated transformation JS 2\",\n \"description\": \"Updated description\",\n \"code\":\"export function transformEvent(event) { return event; }\\n\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/transformations/2MTAtEZbKRQ527ecEXxT0Pw8O11"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"338"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:25:45 GMT"},{"key":"X-Request-ID","value":"a58c1e80-b927-11ed-8176-1b5590f03240"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"AqbfSBgzHDyX6RYPUMZuRil_XRJAc379SK-ScgvllV8D7Us6HigI6w=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTBAAFdGs29S080tsvyg8gbsUj\",\n \"name\": \"Updated transformation JS 2\",\n \"description\": \"Updated description\",\n \"code\": \"export function transformEvent(event) { return event; }\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n}"},{"id":"961ed6fb-3e96-4078-aec0-a480400e83df","name":"Update a Transformation PY","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated transformation PY 2\",\n \"description\": \"Updated description\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/transformations/2MTC32murTn98ouXpBvRY0H0kyF"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"337"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:36:24 GMT"},{"key":"X-Request-ID","value":"22697e10-b929-11ed-9cf4-5393a63a0b2b"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"aFLLBeqAb0vbK9-5TB5w-wZnKM8aqIy4Es8TSp83j_W1Y-POCWVJ1w=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTCSU4NIE3DEMIiUrdAZGjIbC3\",\n \"name\": \"Updated transformation PY 2\",\n \"description\": \"Updated description\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n}"}],"_postman_id":"3f3339c2-6df3-4cf1-b978-08c822d9328f"},{"name":"Update and Publish a Transformation","id":"dd1f2d1b-f1b2-4878-babf-74be0d4c341e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated sample transformation PY 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/transformations/{{id}}?publish=true","description":"This request updates a transformation by creating a new revision and publishes it so that the code is live for all the incoming event traffic.
\n\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}},"urlObject":{"path":["transformations","{{id}}"],"host":["https://api.rudderstack.com"],"query":[{"key":"publish","value":"true"}],"variable":[]}},"response":[{"id":"698a7ce7-9c3d-419b-a4e0-7acec085a372","name":"Update and Publish a Transformation PY","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated sample transformation PY 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/transformations/2MTC32murTn98ouXpBvRY0H0kyF?publish=true","host":["https://api.rudderstack.com"],"path":["transformations","2MTC32murTn98ouXpBvRY0H0kyF"],"query":[{"key":"publish","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"376"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:37:20 GMT"},{"key":"X-Request-ID","value":"41478fc0-b929-11ed-bcb5-b72b6e9d1094"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"DkeR6hXfLJyp2Zygy3G572UxYJhiBiA48WTEG0C2oq2hevf7fNBvuQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTCYpl6VQrSmjbjlgK1b3MKbgW\",\n \"name\": \"Updated sample transformation PY 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n}"},{"id":"a3261526-e0e1-42e0-98b2-76b37e07f7bb","name":"Update and Publish a Transformation JS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated sample transformation JS 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\":\"export function transformEvent(event) { return event; }\\n\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/transformations/2MTAtEZbKRQ527ecEXxT0Pw8O11?publish=true","host":["https://api.rudderstack.com"],"path":["transformations","2MTAtEZbKRQ527ecEXxT0Pw8O11"],"query":[{"key":"publish","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"377"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:26:34 GMT"},{"key":"X-Request-ID","value":"c32a0f10-b927-11ed-8792-85195f9b8279"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"FfzozmxKcPfqSOR6DfgQPlwBKKGcwrS-nd6JWwqWezDIj7nE7Og_9Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTBGMpxfbqBTzINFG6AyNvNVO5\",\n \"name\": \"Updated sample transformation JS 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"export function transformEvent(event) { return event; }\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n}"}],"_postman_id":"dd1f2d1b-f1b2-4878-babf-74be0d4c341e"},{"name":"Delete a Transformation","id":"599d1672-4529-46c0-bfe2-96f65860db57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.rudderstack.com/transformations/{{transformation_id}}","description":"Note: Language cannot be updated i.e. javascript transformation cannot be converted to python or vice versa
\n
This request deletes a transformation associated with the specified ID.
\n\n\nNote that RudderStack does not delete a transformation revision.
\n
This request gets all your transformation revisions by passing an ID.
\nGets the number of objects in your array. By default, it always returns the first 5 objects.
\n","type":"text/plain"},"key":"count","value":""},{"disabled":true,"description":{"content":"You can get all the versions in the ascending order if you pass ASC as the value, or in the descending order if DESC is passed.
\n","type":"text/plain"},"key":"orderBy","value":""}],"variable":[]}},"response":[{"id":"2af7a297-c30e-4a72-9766-fbda4e198dd4","name":"Get All Transformation Revisions JS","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rudderstack.com/transformations/2MTAtEZbKRQ527ecEXxT0Pw8O11/versions","host":["https://api.rudderstack.com"],"path":["transformations","2MTAtEZbKRQ527ecEXxT0Pw8O11","versions"],"query":[{"key":"count","value":"","description":"Gets the number of objects in your array. By default, it always returns the first 5 objects.","type":"text","disabled":true},{"key":"orderBy","value":"","description":"You can get all the versions in the ascending order if you pass ASC as the value, or in the descending order if DESC is passed.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1394"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:27:45 GMT"},{"key":"X-Request-ID","value":"ed867af0-b927-11ed-b969-99f58e664909"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"bpsnpCfdfDSwVrsy_7pqu4v28a_taUN-ewxDg4w4AwUMrjpjaIkLIg=="}],"cookie":[],"responseTime":null,"body":"{\n \"TransformationVersions\": [\n {\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTB8QvNmY75thJf61e9ktiZrRE\",\n \"name\": \"Updated transformation JS 2\",\n \"description\": \"Updated description\",\n \"code\": \"export function transformEvent(event) { return event; }\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n },\n {\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTBGMpxfbqBTzINFG6AyNvNVO5\",\n \"name\": \"Updated sample transformation JS 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"export function transformEvent(event) { return event; }\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n },\n {\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTAtB7m8oR7zLyBJS0QWkuUY93\",\n \"name\": \"Transformation JS 2\",\n \"description\": \"\",\n \"code\": \"export function transformEvent(event) { return event; }\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n }\n ]\n}"},{"id":"e116f143-571d-4588-ae68-aa60fa16446f","name":"Get All Transformation Revisions PY","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rudderstack.com/transformations/2MTC32murTn98ouXpBvRY0H0kyF/versions","host":["https://api.rudderstack.com"],"path":["transformations","2MTC32murTn98ouXpBvRY0H0kyF","versions"],"query":[{"key":"count","value":"","description":"Gets the number of objects in your array. By default, it always returns the first 5 objects.","type":"text","disabled":true},{"key":"orderBy","value":"","description":"You can get all the versions in the ascending order if you pass ASC as the value, or in the descending order if DESC is passed.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1052"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:38:06 GMT"},{"key":"X-Request-ID","value":"5f59ed00-b929-11ed-8da8-cf098d65127d"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"RxPtWnXoPGJZmS4SCNKGe9hce9E54nUZO2YAC5-AidJY0irAfG_b3Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"TransformationVersions\": [\n {\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTCSU4NIE3DEMIiUrdAZGjIbC3\",\n \"name\": \"Updated transformation PY 2\",\n \"description\": \"Updated description\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n },\n {\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTCYpl6VQrSmjbjlgK1b3MKbgW\",\n \"name\": \"Updated sample transformation PY 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n },\n {\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTC30bbSUANEeLb7TeknDbBeFy\",\n \"name\": \"Transformation PY 2\",\n \"description\": \"\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n }\n ]\n}"}],"_postman_id":"9cdf6060-c72a-46bb-9cea-ed1717283c38"},{"name":"Get a Single Transformation Revision","id":"27769938-d106-4fdb-aa38-c78bb4b778fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/transformations/{{id}}/versions/{{version_id}}","description":"This request fetches a single transformation revision.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}},"urlObject":{"path":["transformations","{{id}}","versions","{{version_id}}"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"3c3f9465-0df7-4ce3-b897-94954b972f06","name":"Get a Single Transformation Revision JS","originalRequest":{"method":"GET","header":[],"url":"https://api.rudderstack.com/transformations/2MTAtEZbKRQ527ecEXxT0Pw8O11/versions/2MTBGMpxfbqBTzINFG6AyNvNVO5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"377"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:29:32 GMT"},{"key":"X-Request-ID","value":"2ccd5d00-b928-11ed-bcb5-b72b6e9d1094"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"WNxUgfdVnz43HhU_-M5uTNS7mGV7IBOCGNKYuIXQHSFmzKQFeweHqw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTAtEZbKRQ527ecEXxT0Pw8O11\",\n \"versionId\": \"2MTBGMpxfbqBTzINFG6AyNvNVO5\",\n \"name\": \"Updated sample transformation JS 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"export function transformEvent(event) { return event; }\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:23:30.580Z\",\n \"updatedAt\": \"2023-03-02T18:23:30.580Z\"\n}"},{"id":"eaf58165-1871-44fe-93cd-5a44e48b3e82","name":"Get a Single Transformation Revision PY","originalRequest":{"method":"GET","header":[],"url":"https://api.rudderstack.com/transformations/2MTC32murTn98ouXpBvRY0H0kyF/versions/2MTCYpl6VQrSmjbjlgK1b3MKbgW"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"376"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:38:39 GMT"},{"key":"X-Request-ID","value":"730af8d0-b929-11ed-8792-85195f9b8279"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"nDmAGbfACtyawpK2ZfYhtfFCHWG9b_YFGODLo_RbRdiI5R1d8sw_rw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2MTC32murTn98ouXpBvRY0H0kyF\",\n \"versionId\": \"2MTCYpl6VQrSmjbjlgK1b3MKbgW\",\n \"name\": \"Updated sample transformation PY 2\",\n \"description\": \"Updated sample transformation ready to be published\",\n \"code\": \"def transformEvent(event, metadata):\\n return event\\n\",\n \"codeVersion\": \"1\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:33:02.418Z\",\n \"updatedAt\": \"2023-03-02T18:33:02.418Z\"\n}"}],"_postman_id":"27769938-d106-4fdb-aa38-c78bb4b778fa"}],"id":"e4483e73-202a-406b-8b24-b08c7fe38e33","description":"RudderStack Transformations let you write custom JavaScript or python code that allows you transform your events into a destination-specific format.
\nThe following table explains the different fields in the transformer payload:
\n","_postman_id":"e4483e73-202a-406b-8b24-b08c7fe38e33","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}}},{"name":"Libraries","item":[{"name":"Create a library","id":"f90890b9-de36-41ba-ac21-86bc3772a7b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Transformation Library JS 1\",\n \"description\": \"Some library description\",\n \"code\": \"export default function cube(x) { return x * x * x; }\",\n \"language\": \"javascript\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/libraries","description":"This request creates a transformation library and gets the corresponding JSON object as a response.
\nThis request creates and publishes a transformation library.
\n\n\nNote: The
\npublishflag for a transformation library works the same way as a transformation.
This request fetches all the published transformation libraries.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}},"urlObject":{"path":["libraries"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"6588a1db-beaf-4f24-971b-dbe6ad69afac","name":"List All Libraries","originalRequest":{"method":"GET","header":[],"url":"https://api.rudderstack.com/libraries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"729"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:53:15 GMT"},{"key":"X-Request-ID","value":"7d3c27a0-b92b-11ed-ac71-f73adacb1951"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8832671c1cdfc12eb3e37bd40e58b232.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"vMfwlRcEXRSsGVH53_baSMrU8ofCyoNOuMeLpwB-VGQInh5kwHdgGQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"libraries\": [\n {\n \"id\": \"2MTDFOdoL9qQxFFnhl6oB23oAQ2\",\n \"versionId\": \"2MTDbAFBqzB7Wg8mWyWNBIk5DOU\",\n \"name\": \"Sample Transformation Library JS 2\",\n \"description\": \"Updated library description\",\n \"code\": \"export default function cube(x) { return x * x * x; }\",\n \"language\": \"javascript\",\n \"createdAt\": \"2023-03-02T18:42:53.821Z\",\n \"updatedAt\": \"2023-03-02T18:45:47.510Z\",\n \"importName\": \"sampleTransformationLibraryJs2\"\n },\n {\n \"id\": \"2MTEP4IhlKLXYtnbOqAOx1kKcBd\",\n \"versionId\": \"2MTEP94GdpHFzfwxzqENf5L0WjI\",\n \"name\": \"Sample Transformation Library py 2\",\n \"description\": \"Library description\",\n \"code\": \"def cube(x):\\n return x * x * x\",\n \"language\": \"pythonfaas\",\n \"createdAt\": \"2023-03-02T18:52:24.948Z\",\n \"updatedAt\": \"2023-03-02T18:52:24.948Z\",\n \"importName\": \"sampleTransformationLibraryPy2\"\n }\n ]\n}"}],"_postman_id":"0efc980d-eb94-4d5c-b144-3eda32dd14d1"},{"name":"Retrieve a Single Library","id":"504f325b-feab-407b-bca2-41daba586328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/libraries/:id","description":"Retrieves a single published transformation library based on the specified id.
This request lets you update the code and description of the transformation library by specifying its id.
\n\nNote: You cannot change the name of the transformation library using this request.
\nNote: Language cannot be updated i.e. javascript library cannot be converted to python or vice versa
\n
This request lets you update the code and description of the transformation library by specifying its id and gives you the option of publishing this library.
\n\nNote: Updating the library with the
\npublishoption has the same flow as that of the transformations.Note: Language cannot be updated i.e. javascript library cannot be converted to python or vice versa
\n
This request lets you delete the library given id
\nThis request retrieves all the library revisions for the specified library id.
(Optional) If you want a specific number of versions for the library ID, pass this key. By default, this request always returns the first 5 objects.
\n","type":"text/plain"},"key":"count","value":"5"},{"disabled":true,"description":{"content":"(Optional) To get the library versions in the ascending or descending order, pass this key. By default, the request always returns the ascending order of versions by considering the time of creation of the library version.
\n","type":"text/plain"},"key":"orderBy","value":"ASC/DESC"}],"variable":[{"id":"fff9bbcc-b296-4d9d-a741-37fd53ec683c","type":"any","value":"{{library_id}}","key":"id"}]}},"response":[{"id":"8305c843-e2fe-4043-b85b-5c7ba99011c9","name":"List All Library Revisions PY","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rudderstack.com/libraries/:id/versions","host":["https://api.rudderstack.com"],"path":["libraries",":id","versions"],"query":[{"key":"count","value":"5","description":"(Optional) If you want a specific number of versions for the library ID, pass this key. By default, this request always returns the first 5 objects.","type":"text","disabled":true},{"key":"orderBy","value":"ASC/DESC","description":"(Optional) To get the library versions in the ascending or descending order, pass this key. By default, the request always returns the ascending order of versions by considering the time of creation of the library version.","type":"text","disabled":true}],"variable":[{"key":"id","value":"2MTEP4IhlKLXYtnbOqAOx1kKcBd"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1104"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 19:07:45 GMT"},{"key":"X-Request-ID","value":"83ab9380-b92d-11ed-b448-f3a9b5b5acdb"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 2a5d041359fc84cf7352cd9cc8543898.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"5hR7MSLZowQ8l-9chIAQKrG6ghLzXXuqbY--fAtaHHjCt2oJD07Cmg=="}],"cookie":[],"responseTime":null,"body":"{\n \"libraries\": [\n {\n \"id\": \"2MTEP4IhlKLXYtnbOqAOx1kKcBd\",\n \"versionId\": \"2MTG3koSsphcIwlzyv8SKthFRPW\",\n \"name\": \"Sample Transformation Library py 2\",\n \"description\": \"Updated library code from cube function to a sum function\",\n \"code\": \"def sum(a, b):\\n return a + b\",\n \"language\": \"pythonfaas\",\n \"handleName\": \"sampleTransformationLibraryPy2\",\n \"createdAt\": \"2023-03-02T18:52:24.948Z\",\n \"updatedAt\": \"2023-03-02T18:52:24.948Z\"\n },\n {\n \"id\": \"2MTEP4IhlKLXYtnbOqAOx1kKcBd\",\n \"versionId\": \"2MTGDV2T2k32dwFvqQdMUEhRbN1\",\n \"name\": \"Sample Transformation Library py 2\",\n \"description\": \"Updated library description\",\n \"code\": \"def sum(a, b):\\n return a + b\",\n \"language\": \"pythonfaas\",\n \"handleName\": \"sampleTransformationLibraryPy2\",\n \"createdAt\": \"2023-03-02T18:52:24.948Z\",\n \"updatedAt\": \"2023-03-02T18:52:24.948Z\"\n },\n {\n \"id\": \"2MTEP4IhlKLXYtnbOqAOx1kKcBd\",\n \"versionId\": \"2MTEP94GdpHFzfwxzqENf5L0WjI\",\n \"name\": \"Sample Transformation Library py 2\",\n \"description\": \"Library description\",\n \"code\": \"def cube(x):\\n return x * x * x\",\n \"language\": \"pythonfaas\",\n \"handleName\": \"sampleTransformationLibraryPy2\",\n \"createdAt\": \"2023-03-02T18:52:24.948Z\",\n \"updatedAt\": \"2023-03-02T18:52:24.948Z\"\n }\n ]\n}"},{"id":"e420d627-5b43-45e7-9445-771d728f568c","name":"List All Library Revisions JS","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rudderstack.com/libraries/:id/versions","host":["https://api.rudderstack.com"],"path":["libraries",":id","versions"],"query":[{"key":"count","value":"5","description":"(Optional) If you want a specific number of versions for the library ID, pass this key. By default, this request always returns the first 5 objects.","type":"text","disabled":true},{"key":"orderBy","value":"ASC/DESC","description":"(Optional) To get the library versions in the ascending or descending order, pass this key. By default, the request always returns the ascending order of versions by considering the time of creation of the library version.","type":"text","disabled":true}],"variable":[{"key":"id","value":"2MTDFOdoL9qQxFFnhl6oB23oAQ2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1145"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 Mar 2023 18:46:38 GMT"},{"key":"X-Request-ID","value":"9066e1e0-b92a-11ed-89cb-1766e1e43b8d"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2KDKycoVHAOLttVvzBiqw12O3Hr"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e4ca8fdcd98418fbcfa506572da16d4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HYD57-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"1nEnRkL1gbh475gNShj0Jq_sIwvRTHykdJXEEz1FEtZJyVk_2PyApw=="}],"cookie":[],"responseTime":null,"body":"{\n \"libraries\": [\n {\n \"id\": \"2MTDFOdoL9qQxFFnhl6oB23oAQ2\",\n \"versionId\": \"2MTDV59GAPI4H8SDUt9Y2PNOf0j\",\n \"name\": \"Sample Transformation Library JS 2\",\n \"description\": \"Updated library code from cube function to a sum function\",\n \"code\": \"export function sum(a, b) { return a + b; }\",\n \"language\": \"javascript\",\n \"handleName\": \"sampleTransformationLibraryJs2\",\n \"createdAt\": \"2023-03-02T18:42:53.821Z\",\n \"updatedAt\": \"2023-03-02T18:42:53.821Z\"\n },\n {\n \"id\": \"2MTDFOdoL9qQxFFnhl6oB23oAQ2\",\n \"versionId\": \"2MTDbAFBqzB7Wg8mWyWNBIk5DOU\",\n \"name\": \"Sample Transformation Library JS 2\",\n \"description\": \"Updated library description\",\n \"code\": \"export function sum(a, b) { return a + b; }\",\n \"language\": \"javascript\",\n \"handleName\": \"sampleTransformationLibraryJs2\",\n \"createdAt\": \"2023-03-02T18:42:53.821Z\",\n \"updatedAt\": \"2023-03-02T18:42:53.821Z\"\n },\n {\n \"id\": \"2MTDFOdoL9qQxFFnhl6oB23oAQ2\",\n \"versionId\": \"2MTDFIMteCUnEvFUIawsSosGo40\",\n \"name\": \"Sample Transformation Library JS 2\",\n \"description\": \"Library description\",\n \"code\": \"export default function cube(x) { return x * x * x; }\",\n \"language\": \"javascript\",\n \"handleName\": \"sampleTransformationLibraryJs2\",\n \"createdAt\": \"2023-03-02T18:42:53.821Z\",\n \"updatedAt\": \"2023-03-02T18:42:53.821Z\"\n }\n ]\n}"}],"_postman_id":"944b2cff-4370-4284-8d29-07dc99a3c814"},{"name":"Retrieve a Single Library Revision","id":"e0de7569-f163-4806-b62b-ad6c61218226","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/libraries/:id/versions/:versionId","description":"This request retrieves a single library revision by specifying the library's versionId.
RudderStack’s transformation libraries feature lets you reuse the same code in multiple transformations
\n","_postman_id":"8be6459c-9ab6-48c1-8402-20b49b4bf513","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","id":"b16caf6e-4e69-4ba9-b862-a54dc99657c9","name":"Transformations API","type":"folder"}}},{"name":"Test & Publish API","item":[{"name":"Test a Transformation / Library","id":"1dcd2397-39a0-4596-be7b-8d904d2e8356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"transformations\": [\n {\n \"versionId\": \"2MTC30bbSUANEeLb7TeknDbBeFy\",\n \"testInput\": [\n {\n \"anonymousId\": \"8d872292709c6fbe\",\n \"channel\": \"mobile\",\n \"messageId\": \"m1\"\n },\n {\n \"anonymousId\": \"8d872292709c6fbe\",\n \"channel\": \"mobile\",\n \"messageId\": \"m2\"\n }\n ]\n },\n {\n \"versionId\": \"2MTAtB7m8oR7zLyBJS0QWkuUY93\",\n \"testInput\": [\n {\n \"anonymousId\": \"8d872292709c6fbe\",\n \"messageId\": \"m1\"\n },\n {\n \"anonymousId\": \"8d872292709c6fbe\",\n \"messageId\": \"m2\"\n }\n ]\n }\n ],\n \"libraries\": [\n {\n \"versionId\": \"2MTDbAFBqzB7Wg8mWyWNBIk5DOU\"\n },\n {\n \"versionId\": \"2MTEP94GdpHFzfwxzqENf5L0WjI\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/transformations/libraries/test","description":"This request tests any transformation or library revisions.
\nThis API lets you test your transformation and library revisions.
\n\n\nOutput response shows successful and failed results
\n
This request publishes any transformation or library revisions.
\nThis API lets you publish your transformation and library revisions. However, also note the following:
\n\n\nNote: Whenever you call the
\npublishAPI, we run tests in our server to ensure you don't save any transformation/library code that can lead to any exceptions. \nIn case your publish action fails, verify if the transformation code and the libraries it is referring to are correct.
As an end-user, you can create a transformation/library and perform several edits on it. Note that publishing is optional when you create a transformation or a library.
\nSuppose you perform several edits or revisions on a transformation. RudderStack always takes the latest update as the published version, creates a copy of the older versions, and saves them as revisions. Now suppose that you've created 7 to 8 such revisions of your transformation and now want to use the second revision for transforming your event traffic. You can do this by leveraging RudderStack's Publish API.
\n\n\nNote: Any one of
\ntransformationsorlibrariesmust be present in the payload to make a successfulpublishcall.
Transformations is one of RudderStack's key features. It allows you to leverage custom JavaScript or python functions to transform your source event payload into a destination-specific format.
\nRudderStack Transformations can be used across your Event Stream, Warehouse Actions, and Cloud Extract pipelines, allowing you to implement a variety of use-cases, like:
\n\n\nOur Sample User Transformations GitHub repository contains some useful templates that you can use to create your own user transformations.
\n
For more information on this feature and how to use it, visit our docs.
\nRudderStack's Transformations API allows you to create, read, update and delete transformations and libraries programmatically.
\nThe Transformations API is authenticated via Basic Authentication.
\nYou can authenticate your account by including your email address as the username and the secret access token in the password field under the Authorization tab.
\nAny API requests made without the authentication will fail.
\n\n\nImportant: It is mandatory to generate your access token before you make any API calls. To generate the access token, refer to the Access Token section.
\n
You can also pass your access token in the authorization header directly, as shown:
\nAuthorization: Basic {Base64Encoded(:)}\n\nFor example, if your email address is username@domain.com and the generated access token is 1pHxUIA3jmxS2ip01zY696F80j7, then the header will be:
Basic {Base64Encoded(username@domain.com:1pHxUIA3jmxS2ip01zY696F80j7)}\n\n\n\nImportant: To make success API requests, all the endpoints covered in this guide must include this header.
\n
Creates a tracking plan with the provided schema rules for track and non-track ( identify, group, page and screen) events.
\n\nYou can create an empty tracking plan with no rules.
\n
Example of overwriteEvents=true
Suppose a tracking plan P1 is connected to a track event E1. A new tracking plan P2 is then created with E1 as the payload. As a result, E1 gets updated and its connected plan namely P1 will have latest code of E1.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans"],"host":["https://api.rudderstack.com"],"query":[{"key":"overwriteEvents","value":"true"}],"variable":[]}},"response":[{"id":"ecffda01-d462-46b7-a308-ef4b3a9464b1","name":"Create Tracking Plan with overwriteEvents set to True","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 2\",\n \"rules\": {\n \"identify\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {\n \"type\": \"object\",\n \"properties\": {\n \"age\": {\n \"type\": \"integer\"\n },\n \"anonymousId\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"group\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"industry\": {\n \"type\": \"string\"\n },\n \"plan\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"page\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"url\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": true\n }\n }\n },\n \"screen\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"section\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"resolution\": {\n \"type\": \"object\",\n \"properties\": {\n \"width\": {\n \"type\": \"integer\"\n },\n \"height\": {\n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n }\n },\n \"additionalProperties\": true\n }\n }\n },\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n },\n \"amount\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\",\n \"amount\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans?overwriteEvents=true","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans"],"query":[{"key":"overwriteEvents","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"12"},{"key":"Date","value":"Wed, 14 Jul 2021 07:56:04 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"tp_1vIOHzGFqqmqopsL0vX4Z7QoZuU\",\n \"name\": \"workspaces/1tcUclryAlPoGR8ksIrH163EeHa/tracking-plans/tp_1vIOHzGFqqmqopsL0vX4Z7QoZuU\",\n \"display_name\": \"Plan 2\",\n \"version\": 1,\n \"workspaceId\": \"1tcUclryAlPoGR8ksIrH163EeHa\"\n}"},{"id":"5265ec69-7e83-4fd1-9861-0f7d605a75c3","name":"Create Tracking Plan","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 1\",\n \"rules\": {\n \"identify\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {\n \"type\": \"object\",\n \"properties\": {\n \"age\": {\n \"type\": \"integer\"\n },\n \"anonymousId\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"phone\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"group\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"industry\": {\n \"type\": \"string\"\n },\n \"plan\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"page\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"url\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": true\n }\n }\n },\n \"screen\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"section\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"resolution\": {\n \"type\": \"object\",\n \"properties\": {\n \"width\": {\n \"type\": \"integer\"\n },\n \"height\": {\n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n }\n },\n \"additionalProperties\": true\n }\n }\n },\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n },\n \"amount\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\",\n \"amount\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/trackingplans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"111"},{"key":"Date","value":"Mon, 14 Jun 2021 16:13:13 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"tp_1twjlAMEknGfmJ32U7TlvUosdE9\",\n \"name\": \"workspaces/1tcUclryAlPoGR8ksIrH163EeHa/tracking-plans/tp_1twjlAMEknGfmJ32U7TlvUosdE9\",\n \"display_name\": \"Plan 1\",\n \"version\": 1,\n \"workspaceId\": \"1tcUclryAlPoGR8ksIrH163EeHa\"\n}"}],"_postman_id":"7eec6c80-64e8-444d-bbe4-bd63fb1d886a"},{"name":"Update Tracking Plan","id":"94c64d9b-7027-4fa2-b8aa-b6aa3bda4351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 1\",\n \"rules\": {\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\"\n ]\n },\n \"traits\": {}\n }\n }\n },\n {\n \"name\": \"Cart Viewed\",\n \"description\": \"What cart viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n },\n \"amount\": {\n \"type\": [\n \"number\"\n ]\n },\n \"color\": {\n \"type\": [\n \"string\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\",\n \"amount\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/trackingplans/tp_1twjlAMEknGfmJ32U7TlvUosdE9?overwriteEvents=true","description":"Updates the existing tracking plan with the provided schema rules for track and non-track ( identify, group, page and screen) events.
Note that this request supports only partial updates. For example, suppose events E1 and E2 are connected to the tracking plan P1. If you pass only E2 in the payload to update E2, this does not mean that E1 will lose its connection to the plan P1.
\n\n\nThis request does not support changing the name of the tracking plan.
\n
Creates or updates a tracking plan with the provided schema rules.
\n\n\nTracking plan
\ndisplay_nameis a required field in the Body JSON.
Example of overwriteEvents=true
Suppose a tracking plan P1 is connected to a track event E1. A new tracking plan P2 is then created with E1 as the payload. As a result, E1 gets updated and its connected plan namely P1 will have latest code of E1.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans"],"host":["https://api.rudderstack.com"],"query":[{"key":"overwriteEvents","value":"true"}],"variable":[]}},"response":[{"id":"72442d51-9753-4a89-8f33-d865f08356c9","name":"Upsert Tracking Plan: overwrite set to false","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic dGVzdDE2MjQ4NTUyNjM0NDVAcnVkZGVybGFicy5jb206MXVZdkpQS1JwU3pESUp3b2NDanhLMDlaSWU4","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 1\",\n \"rules\": {\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\",\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\"\n ]\n },\n \"traits\": {}\n }\n }\n },\n {\n \"name\": \"Items Viewed\",\n \"description\": \"What items viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans?overwriteEvents=false","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans"],"query":[{"key":"overwriteEvents","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"Date","value":"Wed, 14 Jul 2021 06:50:26 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Order Viewed already exists. Duplicate event name not allowed\"\n}"},{"id":"e026a8f4-0ede-4d6e-b276-707bfb70852d","name":"Upsert Tracking Plan","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 1\",\n \"rules\": {\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\",\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\"\n ]\n },\n \"traits\": {}\n }\n }\n },\n {\n \"name\": \"Items Viewed\",\n \"description\": \"What items viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans?overwriteEvents=true","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans"],"query":[{"key":"overwriteEvents","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2656"},{"key":"Date","value":"Wed, 14 Jul 2021 06:53:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/1uYvJRE0aXPpZBhc4jaEltNM2aO/tracking-plans/tp_1uYvJmOo8q4WhrJYNTZ8AteqUmY\",\n \"display_name\": \"Plan 1\",\n \"version\": 13,\n \"rules\": {\n \"events\": [\n {\n \"id\": \"ev_1vGLsaiMsswxwRhwOhYDkJzUkVN\",\n \"name\": \"Cart Viewed\",\n \"description\": \"What cart viewed\",\n \"version\": \"1-0-0\",\n \"rules\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {},\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"required\": [\n \"product\",\n \"price\",\n \"amount\"\n ],\n \"properties\": {\n \"color\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n },\n \"amount\": {\n \"type\": [\n \"number\"\n ]\n },\n \"product\": {\n \"type\": [\n \"string\"\n ]\n }\n }\n }\n }\n }\n },\n {\n \"id\": \"ev_1vG8AR1KcZUVyrVyCjFLDaDTDau\",\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"version\": \"5-0-0\",\n \"rules\": {\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"traits\": {},\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"required\": [\n \"product\",\n \"price\"\n ],\n \"properties\": {\n \"price\": {\n \"type\": [\n \"number\"\n ]\n },\n \"product\": {\n \"type\": [\n \"string\"\n ]\n }\n }\n }\n }\n }\n },\n {\n \"id\": \"ev_1vINRejosp7AuBnlq4qwoHSWNzZ\",\n \"name\": \"Items Viewed\",\n \"description\": \"What items viewed\",\n \"version\": \"1-0-0\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n}"},{"id":"9d4e4733-c747-44a5-a731-e2826c8d7179","name":"Upsert Tracking Plan: create tracking plan (given new name) overwriteEvents set to true","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"tracking_plan\": {\n \"display_name\": \"Plan 2\",\n \"rules\": {\n \"events\": [\n {\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n }\n },\n \"required\": [\n \"product\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans?overwriteEvents=true","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans"],"query":[{"key":"overwriteEvents","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1010"},{"key":"Date","value":"Wed, 14 Jul 2021 07:00:53 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/1tcUclryAlPoGR8ksIrH163EeHa/tracking-plans/tp_1vIOHzGFqqmqopsL0vX4Z7QoZuU\",\n \"display_name\": \"Plan 2\",\n \"version\": 1,\n \"rules\": {\n \"events\": [\n {\n \"id\": \"ev_1vG8AR1KcZUVyrVyCjFLDaDTDau\",\n \"name\": \"Order Viewed\",\n \"description\": \"Whose order viewed\",\n \"version\": \"7-0-0\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n }\n },\n \"required\": [\n \"product\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"3b9f36e8-8c78-40fb-8841-04bb1006d79c"},{"name":"Get Tracking Plan by ID","id":"cac4b791-4fb9-4e0a-bad0-5036e43341dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/v1/dg/trackingplans/tp_1twjlAMEknGfmJ32U7TlvUosdE9?version=1","description":"Fetches the tracking plan by its ID, linked events, as well as the track and non-track ( identify, group, page and screen) schemas.
\n\nYou can also get the previous tracking plan versions with an optional query parameter
\nversion.
Fetches all the tracking plans present in the authenticated user's workspace.
\nDeletes a tracking plan specified by the ID.
\n\n\nMake sure the tracking plan is not linked to any source.
\nIf you try to delete a tracking plan that is connected to a source, you will get a 403 Forbidden error.
\n
For more information on unlinking a tracking plan from a source, see Delete Tracking Plan-Source Connection.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans","{{tracking_plan_id}}"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"1ac50acc-8c51-4b98-b270-e4e8fdf089e7","name":"Delete Tracking Plan","originalRequest":{"method":"DELETE","header":[],"url":"https://api.rudderstack.com/v1/dg/trackingplans/{{tracking_plan_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Apr 2023 07:25:53 GMT"},{"key":"X-Request-ID","value":"43657900-d44c-11ed-b382-130d4942cd29"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2HE8UjUYZa31Hmg0CUMr1eQqSNC"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5b606f2bb4210a5fee31ecb5e5cc7612.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-P2"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"WWw3Bpi7VspnO1wrrWD-dKJgQONSGQNDs5jTGSAdG6iuV00PM7Kjqw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"333557c9-6870-4b8f-9b12-3f7ab01ef356"}],"id":"2a5b999c-b417-4622-ad13-d212e4e211d1","description":"Tracking Plan lets you proactively monitor and act on any non-compliant event data coming into your RudderStack sources based on predefined plans. This can help you prevent or de-risk situations where missing or improperly configured event data can break your downstream destinations.
\n\n\nTracking plans let you define specific event names and properties for your
\ntrackcalls, and properties for your non-track ( identify, group, page and screen) calls.
For more information on the Tracking Plans feature, refer to the Tracking Plans documentation.
\n","_postman_id":"2a5b999c-b417-4622-ad13-d212e4e211d1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}}},{"name":"Tracking Plan Rules","item":[{"name":"Events","item":[{"name":"Create Events in the User Workspace","id":"f03a3fed-8016-4159-a12c-033097a908aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"New Event 1\",\n \"description\": \"New event\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"price\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"price\"\n ]\n },\n \"traits\": {}\n }\n }\n },\n {\n \"name\": \"New Event 2\",\n \"description\": \"New event\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n },\n \"amount\": {\n \"type\": [\n \"number\"\n ]\n }\n },\n \"required\": [\n \"product\",\n \"amount\"\n ]\n },\n \"traits\": {}\n }\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/events","description":"Creates new events in the authenticated user's workspace.
\nA few things to note:
\nFetches all the events present in the authenticated user's workspace irrespective of whether they are linked to a tracking plan.
\n\n\nNote that the event ID and version are autogenerated.
\n
Updates the existing event and the corresponding tracking plans linked to that event.
\n\n\nAn update to the event description does not update the version of the linked tracking plans.
\n
Link the events to a given tracking plan.
\n\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans","{{tracking_plan_id}}","events","link"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"94998336-311f-480d-8e35-a00ffc92f2cc","name":"Link Events","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\"ev_1twlyewLH4dov4WRl5dAx4gPIRi\", \"ev_1twlyaUTYvZJ6CqIuSr7axGlpnz\"]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans/:id/events/link","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans",":id","events","link"],"variable":[{"key":"id","value":"tp_1twjlAMEknGfmJ32U7TlvUosdE9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Date","value":"Mon, 14 Jun 2021 16:39:42 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"5c49234b-b898-44a6-8519-a4ca3a5f62e0"},{"name":"Unlink Events from a Tracking Plan","id":"666e398d-0087-4aa1-bb24-91baa2a03042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\"ev_2O2o2YyRw24oa2ixcRBlJkH5cH6\"]","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/trackingplans/{{tracking_plan_id}}/events/unlink","description":"Note that the tracking plan ID is specified in the request and the event IDs are passed in the request body.
\n
Unlinks the events (specified by their IDs) from a given tracking plan.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans","{{tracking_plan_id}}","events","unlink"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"827570cb-9aa0-43e0-9c6a-3d4370dd8e4b","name":"Unlink Events","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\"ev_1twjlAeyZLr0B0fFvHI7NIqKX32\"]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans/:id/events/unlink","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans",":id","events","unlink"],"variable":[{"key":"id","value":"tp_1twjlAMEknGfmJ32U7TlvUosdE9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Date","value":"Mon, 14 Jun 2021 16:41:27 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"666e398d-0087-4aa1-bb24-91baa2a03042"},{"name":"Get All Events Linked to a Tracking Plan (Including Deleted and Active Events)","event":[{"listen":"test","script":{"id":"bdc21f96-e9e8-4a81-a088-18290c23e271","exec":[""],"type":"text/javascript"}}],"id":"797574e5-fe13-4422-8242-2ce9d05ea69d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/v1/dg/trackingplans/:id/events/all","description":"Fetches all the events linked to the given tracking plan, including both deleted and active events.
\n\n\nThe deleted events are referred to as unlinked events.
\n
Deletes an events specified by the ID from the user's workspace.
\n\n\nMake sure you unlink the event from all the tracking plans to which it is linked. Otherwise you will get a 403 Forbidden error.
\n
If you try to delete an event that is linked to a tracking plan, you will get the following message:
\nEvent still connected to tracking plans: {tracking_plan_id}
\nThis message lists all the tracking plans to which the event is currently linked. You can then unlink the events from those tracking plans.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","events","{{event_id}}"],"host":["https://api.rudderstack.com"],"query":[],"variable":[]}},"response":[{"id":"778fd13c-08cd-45ea-83a0-4685b7368b2f","name":"Delete Events","originalRequest":{"method":"DELETE","header":[],"url":"https://api.rudderstack.com/v1/dg/events/{{event_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Apr 2023 07:53:22 GMT"},{"key":"X-Request-ID","value":"1a6ff350-d450-11ed-bf7c-bb0957f02c67"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-User-ID","value":"2HE8UjUYZa31Hmg0CUMr1eQqSNC"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7e789934ab3bcbc8565056b7ff464c92.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-P2"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"bSZIh553zZRzERa2e0NF45oow4edy6oBVuVDzgb5kx5cVYgK0wh93g=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"b5d9355d-3c1c-40ae-bf83-1f090e32c2bd","name":"Event still linked to a Tracking Plan","originalRequest":{"method":"DELETE","header":[],"url":"https://api.rudderstack.com/v1/dg/events/{{event_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"85"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Apr 2023 08:06:09 GMT"},{"key":"X-Request-ID","value":"e3cfa870-d451-11ed-a906-5599f0367df7"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7e789934ab3bcbc8565056b7ff464c92.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-P2"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"ct4UmldazM6yyAdV5GQg081Nb7FRSHQOKRGfZ9LmFLM_khC4yncv_w=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"event still connected to tracking plans: tp_2O2oIhFCaY4v3HCaKmxzgwLAB18\"\n}"}],"_postman_id":"9f309ec6-77fe-4b32-97fa-737d662cf2d4"}],"id":"ca1ec9d6-672f-4d20-b3b5-e6d348c66828","_postman_id":"ca1ec9d6-672f-4d20-b3b5-e6d348c66828","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}}},{"name":"Non-Track Rules","item":[{"name":"Map Non-Track Rule to Tracking Plan","id":"d88d2dab-6039-495a-9a9d-f3c0f3ff64fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"object\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"url\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/trackingplans/tp_2Q0GDOl12OXATIg4zOytv6t5ywl/rules/{{ruleType}}","description":"Create or updates a non-track rule of type identify, group, page or screen for a tracking plan.
Deletes a non-track rule of type identify, group, page or screen mapped to a tracking plan.
Upsert and Delete APIs for all non-track rules (identify, group, page and screen).
\n","_postman_id":"25102209-0532-4223-97bb-3cf7ddbec50e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}}}],"id":"dfa3156f-216f-4399-bd5d-c57e077ba406","event":[{"listen":"prerequest","script":{"id":"4ceee88f-046a-414c-8095-7589def766c9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"67796220-baef-43d2-87b3-abb4f2ccfaf7","type":"text/javascript","exec":[""]}}],"_postman_id":"dfa3156f-216f-4399-bd5d-c57e077ba406","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}}},{"name":"Source Tracking Plan Connections","item":[{"name":"Create/Update Source Configuration","id":"16b756f9-1975-47a0-82fa-0ebadb3fe38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"track\": {\n \"allowUnplannedEvents\": \"true\",\n \"unplannedProperties\": \"forward\",\n \"anyOtherViolation\": \"forward\",\n \"propagateValidationErrors\": \"true\"\n },\n \"global\": {\n \"allowUnplannedEvents\": \"true\",\n \"unplannedProperties\": \"forward\",\n \"anyOtherViolation\": \"forward\",\n \"propagateValidationErrors\": \"true\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rudderstack.com/v1/dg/sources/:sourceId/config","description":"Creates or updates the tracking plan configuration for a given source ID.
\nThe configuration settings are listed in the following sections:
\nThe global parameter indicates the configuration settings applicable for all events.
However, note that the event-level configuration settings will override the settings defined in the global parameter. In the example request on the right, the settings defined for track will override the settings defined for global.
Fetches the tracking plan configuration for a given source ID.
\n\n\nYou can get the previous tracking plan configuration versions with an optional query parameter
\nversion.
Connects a tracking plan to source. Note that this request supports create or update operations for only one tracking plan connection at a time.
\n\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans",":id","source-connections"],"host":["https://api.rudderstack.com"],"query":[],"variable":[{"type":"any","value":"{{tracking_plan_id}}","key":"id"}]}},"response":[{"id":"2e99e0ae-e085-4ded-817f-052d91242c7b","name":"Create Connection","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_id\": \"1qSuNc0KtpNOuesADEHAnRzihZq\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans/:id/source-connections","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans",":id","source-connections"],"variable":[{"key":"id","value":"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"141"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 10 Nov 2021 13:02:21 GMT"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Request-ID","value":"70cbd600-4226-11ec-87ae-191b21e4b239"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c94da9cdc6b5a8cdec5c3956d92170f5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-C3"},{"key":"X-Amz-Cf-Id","value":"Ufp35NM6XYBDS6ZxpFWaIUi0rpM73wV2Hhd8lHQ_TWkPIC-LnxhlXw=="}],"cookie":[],"responseTime":null,"body":"{\n \"source_name\": \"workspaces/1n6JajCyRa12om0GB1FxGEodIf8/sources/1qSuNc0KtpNOuesADEHAnRzihZq\",\n \"tracking_plan\": \"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3\"\n}"}],"_postman_id":"d7cfd499-57b8-4f3e-b162-dc86f8e22abc"},{"name":"List Tracking Plan-Source Connections","id":"35c80ee6-4e3b-43ef-b651-bbb07e088e57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rudderstack.com/v1/dg/trackingplans/:id/source-connections","description":"If source is already linked to plan, this request overrides existing tracking plan connection.
\n
Fetches all the sources connected to given tracking plan.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans",":id","source-connections"],"host":["https://api.rudderstack.com"],"query":[],"variable":[{"type":"any","value":"{{tracking_plan_id}}","key":"id"}]}},"response":[{"id":"f405abbe-3aec-4782-89c9-6baf93cf54de","name":"List of connections to Tracking Plan","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans/:id/source-connections","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans",":id","source-connections"],"variable":[{"key":"id","value":"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"307"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 10 Nov 2021 13:06:19 GMT"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Request-ID","value":"fec4bee0-4226-11ec-b255-7f702116b536"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c94da9cdc6b5a8cdec5c3956d92170f5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-C3"},{"key":"X-Amz-Cf-Id","value":"tHaY6j9wuEqvs0EvB4u4Om-8fr6bjTgaRV_ltYxjzRNsmWg9OgZeeA=="}],"cookie":[],"responseTime":null,"body":"{\n \"connections\": [\n {\n \"source_name\": \"workspaces/1n6JajCyRa12om0GB1FxGEodIf8/sources/1qSuNc0KtpNOuesADEHAnRzihZq\",\n \"tracking_plan_id\": \"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3\"\n },\n {\n \"source_name\": \"workspaces/1n6JajCyRa12om0GB1FxGEodIf8/sources/1uJ1Ofn6qRh92sGeyJE1bueU3u7\",\n \"tracking_plan_id\": \"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3\"\n }\n ]\n}"}],"_postman_id":"35c80ee6-4e3b-43ef-b651-bbb07e088e57"},{"name":"Delete Tracking Plan-Source Connection","id":"1ac49332-3c6f-44ee-9041-3065900cf5f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.rudderstack.com/v1/dg/trackingplans/:id/source-connections/:sourceId","description":"Deletes the connection between a given source ID and a tracking plan ID.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":true,"source":{"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e","name":"Tracking Plan API","type":"folder"}},"urlObject":{"path":["v1/dg","trackingplans",":id","source-connections",":sourceId"],"host":["https://api.rudderstack.com"],"query":[],"variable":[{"type":"any","value":"{{tracking_plan_id}}","key":"id"},{"type":"any","value":"{{source_id}}","key":"sourceId"}]}},"response":[{"id":"b7ba7bb5-a0f4-4eb7-9d7b-8ff51621bbcd","name":"Delete Source connection","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.rudderstack.com/v1/dg/trackingplans/:id/source-connections/:sourceId","protocol":"https","host":["api","rudderstack","com"],"path":["v1","dg","trackingplans",":id","source-connections",":sourceId"],"variable":[{"key":"id","value":"tp_1ySO5mS8gK3gvyC88YiJJVj7hr3"},{"key":"sourceId","value":"1qSuNc0KtpNOuesADEHAnRzihZq"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 10 Nov 2021 13:08:12 GMT"},{"key":"Vary","value":"Origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Request-ID","value":"4244ddd0-4227-11ec-87ae-191b21e4b239"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c94da9cdc6b5a8cdec5c3956d92170f5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BLR50-C3"},{"key":"X-Amz-Cf-Id","value":"kto1xRYQAVUp_VrG3aKSej3dgZcON47G6d25uMrUI9MfSZob5CpC2w=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"1ac49332-3c6f-44ee-9041-3065900cf5f6"}],"id":"4b74ffd2-de44-43c9-b2a4-2d65e4fb61c9","description":"This section covers the requests needed for:
\nThis collection contains a list of the supporting Data Governance API calls and models with relevant examples.
\nYou can generate the personal access token to access this API by following the documentation here.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{email_address}}"},{"key":"password","value":"{{personal_access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5275bda7-ac5a-4cdd-b108-286d1cb64739","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c9b57cb9-acf9-4462-b429-61a3e93bdf02","type":"text/javascript","exec":[""]}}],"_postman_id":"7df289e7-8758-4ec0-a86e-3aa08bd3260e"},{"name":"Test API","item":[{"name":"Verifying destination events","id":"9923f49c-5ec7-43b5-926f-b1307d506008","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"