For more information see, the Adverity Documentation.
\nLast Updated: 2024-03-14
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4861982","collectionId":"288e6b34-ede4-4516-92ca-7119130ecaf1","publishedId":"SWT7CKex","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"404E55","highlight":"EC6A2D"},"publishDate":"2021-10-06T12:44:49.000Z"},"item":[{"name":"Get Started","item":[{"name":"Authentication: Get token","id":"67b48f3c-5c1d-4b47-8037-190192a97074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"username\": \"{{USERNAME}}\",\r\n \"password\": \"{{PASSWORD}}\",\r\n \"expires_in\": {{EXPIRATION}}}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/auth/token/","urlObject":{"protocol":"https","path":["api","auth","token",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67b48f3c-5c1d-4b47-8037-190192a97074"},{"name":"Refresh MAPI key","id":"85d5657d-3a00-4d48-9f1a-71259be29d9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/v1/auth/keys/current/rotate/","urlObject":{"protocol":"https","path":["api","v1","auth","keys","current","rotate",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85d5657d-3a00-4d48-9f1a-71259be29d9c"},{"name":"List all endpoints","id":"075d0502-e4f1-4234-88b3-1fc4912e2b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/","urlObject":{"protocol":"https","path":["api",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"075d0502-e4f1-4234-88b3-1fc4912e2b62"}],"id":"f76d37b5-7848-4666-872b-1118b0f09ea6","description":"When sending requests to Management API, use the Authorization header in one of the following ways:
\n--header 'Authorization: Token {{KEY}}'--header 'Authorization: Bearer {{KEY}}'Note: the request examples provide both options, select the one you are using.
\n","_postman_id":"f76d37b5-7848-4666-872b-1118b0f09ea6"},{"name":"Workspaces","item":[{"name":"List workspaces","id":"c5198aa1-2f1c-46c1-9bb4-f9e3582d36de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/stacks/","urlObject":{"protocol":"https","path":["api","stacks",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5198aa1-2f1c-46c1-9bb4-f9e3582d36de"},{"name":"List storages","id":"3bbff3de-4cc7-4e49-8f8c-362bb3ddfb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/storage/","urlObject":{"protocol":"https","path":["api","storage",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bbff3de-4cc7-4e49-8f8c-362bb3ddfb78"},{"name":"Create a new workspace","id":"582f4867-0457-4d43-a8ee-ede3ef660b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"datalake_id\": {{STORAGE_ID}},\r\n \"name\": \"NEW_WORKSPACE_NAME\"}"},"url":"https://{{INSTANCE}}/api/stacks/","urlObject":{"protocol":"https","path":["api","stacks",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"582f4867-0457-4d43-a8ee-ede3ef660b64"},{"name":"Edit an existing workspace","id":"ddeae262-f7ea-4c58-9a2a-82e81ad3e814","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"parent_id\": PARENT_ID}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/stacks/{{STACK_SLUG}}/","urlObject":{"protocol":"https","path":["api","stacks","{{STACK_SLUG}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ddeae262-f7ea-4c58-9a2a-82e81ad3e814"},{"name":"View information about an existing workspace","id":"f9699edf-172f-4c60-b33c-068b61f99147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{INSTANCE}}/api/stacks/{{STACK_SLUG}}","urlObject":{"protocol":"https","path":["api","stacks","{{STACK_SLUG}}"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9699edf-172f-4c60-b33c-068b61f99147"},{"name":"List workspaces (v1)","id":"e0a17dd4-e5dd-44f1-9657-9b39872485e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{KEY}}","disabled":false}],"url":"https://{{INSTANCE}}/api/v1/workspaces/","urlObject":{"protocol":"https","path":["api","v1","workspaces",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0a17dd4-e5dd-44f1-9657-9b39872485e4"}],"id":"c23aeeff-0af9-4f2c-a3fb-810643fbfac3","event":[{"listen":"prerequest","script":{"id":"b8aa11ef-94c2-4db7-9561-95aa28be9a4f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0331b20e-0053-4ba0-9662-f92350282d6c","type":"text/javascript","exec":[""]}}],"_postman_id":"c23aeeff-0af9-4f2c-a3fb-810643fbfac3","description":""},{"name":"Connections (authorizations)","item":[{"name":"List connection types","id":"3ada725b-81a8-4d87-a941-16064e297302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/connection-types/","urlObject":{"protocol":"https","path":["api","connection-types",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ada725b-81a8-4d87-a941-16064e297302"},{"name":"List all connections of a type","id":"1c28d177-752b-4ab1-92bb-cf8bb082567e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c28d177-752b-4ab1-92bb-cf8bb082567e"},{"name":"Retrieve options for a connection type","id":"653682f8-21c6-40d0-a0ea-676a1c4a84d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"653682f8-21c6-40d0-a0ea-676a1c4a84d5"},{"name":"Create a new connection","id":"ba2478e9-0ebf-4858-ad5f-efda9d3ef28a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"body":{"mode":"raw","raw":"{\"name\": \"NEW_CONNECTION\",\r\n \"stack\": {{STACK_ID}},\r\n \"username\": \"username\",\r\n \"password\": \"password\"\r\n \"app\": {{APP_ID}}}"},"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/","description":"Depending on which type was chosen, the required parameters placed within the body will vary.
\n","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba2478e9-0ebf-4858-ad5f-efda9d3ef28a"},{"name":"Authorize a connection","id":"4c66a9f4-e089-4898-af1e-42a8e86a816b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/{{CONNECTION_ID}}/authorize/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections","{{CONNECTION_ID}}","authorize",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c66a9f4-e089-4898-af1e-42a8e86a816b"},{"name":"Create an authorization and authorization link","id":"aec0d8e6-5fc7-4ce3-a87c-2b2e9151d4d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"content_types\": [\r\n {\r\n \"content_type\": \"{{CONNECTION_TYPE_ID}}\",\r\n \"name\": \"{{CONNECTION_NAME}}\"\r\n }\r\n ],\r\n \"email\": \"recipient_email@organization.com\",\r\n \"notification_emails\": [\"email1@organization.com\", \"email2@organization.com\"],\r\n \"stack\": {{STACK_ID}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/connection-invite/","urlObject":{"protocol":"https","path":["api","connection-invite",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aec0d8e6-5fc7-4ce3-a87c-2b2e9151d4d2"},{"name":"Edit a connection","id":"fdcfb656-5324-46f5-b202-4bd6da5f3d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"{{NEW_NAME}}\"}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/{{CONNECTION_ID}}/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections","{{CONNECTION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdcfb656-5324-46f5-b202-4bd6da5f3d29"},{"name":"Delete a connection","id":"159ea42c-0163-4b67-b3ab-b808ce188173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/{{CONNECTION_ID}}/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections","{{CONNECTION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"159ea42c-0163-4b67-b3ab-b808ce188173"},{"name":"Update an authorization token","id":"e486f1a7-eba6-4cfd-bf89-17b5e32a5b1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"access_token\": \"ACCESS_TOKEN\",\r\n\t\"refresh_token\": \"REFRESH_TOKEN\",\r\n\t\"expires\": \"EXPIRATION_DATE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/{{CONNECTION_ID}}/token/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections","{{CONNECTION_ID}}","token",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e486f1a7-eba6-4cfd-bf89-17b5e32a5b1f"}],"id":"38529ab1-797e-4ae1-adfc-1e02fdca57ec","_postman_id":"38529ab1-797e-4ae1-adfc-1e02fdca57ec","description":""},{"name":"Billing Objects","item":[{"name":"Update connection's metadata","id":"a98dc73e-f919-491c-ad17-52c921bf4b35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/connection-types/{{CONNECTION_TYPE}}/connections/{{CONNECTION_ID}}/update/","urlObject":{"protocol":"https","path":["api","connection-types","{{CONNECTION_TYPE}}","connections","{{CONNECTION_ID}}","update",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a98dc73e-f919-491c-ad17-52c921bf4b35"},{"name":"List Billing Objects","id":"018d6717-0824-4875-aebb-9ab90d60e625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token REMOVED"}],"url":"https://{{INSTANCE}}/api/billings/{{CONNECTION_ID}}","urlObject":{"protocol":"https","path":["api","billings","{{CONNECTION_ID}}"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"018d6717-0824-4875-aebb-9ab90d60e625"},{"name":"Give access to selected Billing Objets","id":"a6f7b6ee-36ad-4135-a429-40b93520eb9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token REMOVED"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"objects\":[\r\n {\r\n \"id\":{{ID}},\r\n \"is_enabled\":true\r\n }\r\n ],\r\n \"enable_all_billing_objects\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/billings/{{CONNECTION_ID}}/","urlObject":{"protocol":"https","path":["api","billings","{{CONNECTION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6f7b6ee-36ad-4135-a429-40b93520eb9f"},{"name":"Give access to all Billing Objects","id":"8c208463-68c1-4d24-a2b4-9c409b188751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token REMOVED"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"objects\":[],\r\n \"enable_all_billing_objects\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/billings/{{CONNECTION_ID}}","urlObject":{"protocol":"https","path":["api","billings","{{CONNECTION_ID}}"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c208463-68c1-4d24-a2b4-9c409b188751"},{"name":"Export available Billing Objects","id":"dd6147db-22b6-4c16-8d57-92e4a51be923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Accept","value":"text/csv"}],"url":"https://{{INSTANCE}}/api/billing-objects/export/","urlObject":{"protocol":"https","path":["api","billing-objects","export",""],"host":["{{INSTANCE}}"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"dd6147db-22b6-4c16-8d57-92e4a51be923"}],"id":"5fc7ee4c-edfe-4b80-bd2c-88ed21bcf329","_postman_id":"5fc7ee4c-edfe-4b80-bd2c-88ed21bcf329","description":""},{"name":"Datastreams","item":[{"name":"List available datastream types","id":"2c93ed97-905a-4b83-9c1c-43a954ac0d27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/","urlObject":{"protocol":"https","path":["api","datastream-types",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c93ed97-905a-4b83-9c1c-43a954ac0d27"},{"name":"Search for specific datastream types by name","id":"62650eb2-6d1b-4a98-a4f2-16d61abd9379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/?search={{DATASTREAM_TYPE_NAME}}","urlObject":{"protocol":"https","path":["api","datastream-types",""],"host":["{{INSTANCE}}"],"query":[{"key":"search","value":"{{DATASTREAM_TYPE_NAME}}"}],"variable":[]}},"response":[],"_postman_id":"62650eb2-6d1b-4a98-a4f2-16d61abd9379"},{"name":"List datastreams of a specific type","id":"a951659a-c134-4fb9-a6d2-9dd9a799adc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a951659a-c134-4fb9-a6d2-9dd9a799adc9"},{"name":"Retrieve options for a datastream type","id":"bfce2aad-93ed-4d02-846d-8059178536ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bfce2aad-93ed-4d02-846d-8059178536ed"},{"name":"Create a new datastream","id":"b18d40a2-3250-48f7-a4d5-5233d38a0216","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"datatype\": \"Staging\",\r\n \"cron_type\": \"day\",\r\n \"name\": \"NAME_OF_STREAM\",\r\n \"stack\": {{STACK_ID}},\r\n \"auth\": {{CONNECTION_ID}}\r\n}"},"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/","description":"Depending on which type was chosen, the required parameters placed within the body will vary.
\n","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b18d40a2-3250-48f7-a4d5-5233d38a0216"},{"name":"Enable a datastream","id":"bc925f50-aec4-4c11-94d0-10da919053c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"enabled\": true}"},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc925f50-aec4-4c11-94d0-10da919053c4"},{"name":"List datastreams of a specific type","id":"13671677-d84d-4326-a6f8-5c11e3eaebe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"13671677-d84d-4326-a6f8-5c11e3eaebe5"},{"name":"View current datastream configuration","id":"11c78eb3-037f-42e2-bafe-089e3dbc1670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"11c78eb3-037f-42e2-bafe-089e3dbc1670"},{"name":"Retrieve options for a datastream","id":"7dc07abb-6c7b-457e-8e2b-c60576d86443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7dc07abb-6c7b-457e-8e2b-c60576d86443"},{"name":"Edit datastream configuration","id":"dda56b73-0103-4a4e-8d3e-c6cda6f1a916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"CHANGED_NAME\"}"},"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dda56b73-0103-4a4e-8d3e-c6cda6f1a916"},{"name":"Delete a datastream","id":"ac492aa9-7932-48d9-8ec6-36f8b69a9c08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac492aa9-7932-48d9-8ec6-36f8b69a9c08"}],"id":"e4b5764c-d2ef-442a-ad0b-34babead9533","_postman_id":"e4b5764c-d2ef-442a-ad0b-34babead9533","description":""},{"name":"Fetching and scheduling","item":[{"name":"Run a single fetch","id":"dea765f0-d86f-4d48-b3bd-b35977680c05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"start\": \"YYYY-MM-DDTHH:MMH:SSZ\",\r\n \"end\": \"YYYY-MM-DDTHH:MMH:SSZ\",\r\n \"priority\":\"{{PRIORITY}}\"}"},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/fetch_fixed/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","fetch_fixed",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dea765f0-d86f-4d48-b3bd-b35977680c05"},{"name":"Download the most recent extract of a datastream","id":"b27ee56e-2cec-444a-bde2-3747c3af21dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/extracts/most-recent/download/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","extracts","most-recent","download",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b27ee56e-2cec-444a-bde2-3747c3af21dc"},{"name":"List extracts","id":"e5a74db2-1aac-4b52-a44c-83793d659e40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/extracts/","urlObject":{"protocol":"https","path":["api","extracts",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5a74db2-1aac-4b52-a44c-83793d659e40"},{"name":"List extracts for a datastream","id":"32fc2d13-8734-4e57-98af-24c785e44282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/extracts/?datastream_id={{DATASTREAM_ID}}","urlObject":{"protocol":"https","path":["api","extracts",""],"host":["{{INSTANCE}}"],"query":[{"key":"datastream_id","value":"{{DATASTREAM_ID}}"}],"variable":[]}},"response":[],"_postman_id":"32fc2d13-8734-4e57-98af-24c785e44282"},{"name":"Download a single extract","id":"1bfd3522-e880-4d48-82f3-0c0c5f1b2902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/extracts/{{EXTRACT_ID}}/download/","urlObject":{"protocol":"https","path":["api","extracts","{{EXTRACT_ID}}","download",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bfd3522-e880-4d48-82f3-0c0c5f1b2902"},{"name":"Create a new schedule","id":"0980a394-6677-47d3-8eb2-43049a15d93a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"cron_preset\": \"CRON_EVERY_DAY\",\r\n \"cron_type\": \"day\",\r\n \"cron_interval\": 1,\r\n \"cron_start_of_day\": \"00:00:00\",\r\n \"cron_interval_start\": 1,\r\n \"time_range_preset\": 0,\r\n \"time_range_preset_label\": \"Fixed Time Range\",\r\n \"delta_type\": 1,\r\n \"delta_interval\": 1,\r\n \"delta_start_of_day\": \"00:00:00\",\r\n \"delta_interval_start\": 1,\r\n \"fixed_start\": \"2021-12-01\",\r\n \"fixed_end\": \"2021-12-02\",\r\n \"offset_days\": \r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0980a394-6677-47d3-8eb2-43049a15d93a"},{"name":"Create multiple schedules","id":"59f369a1-744f-4a66-924b-d19670abee9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"schedules\": [\r\n {\r\n \"cron_preset\": \"CRON_EVERY_DAY\",\r\n \"cron_type\": \"day\",\r\n \"cron_interval\": 1,\r\n \"cron_start_of_day\": \"00:00:00\",\r\n \"cron_interval_start\": 1,\r\n \"time_range_preset\": 0,\r\n \"time_range_preset_label\": \"Fixed Time Range\",\r\n \"delta_type\": 1,\r\n \"delta_interval\": 1,\r\n \"delta_start_of_day\": \"00:00:00\",\r\n \"delta_interval_start\": 1,\r\n \"fixed_start\": \"2021-12-01\",\r\n \"fixed_end\": \"2021-12-02\",\r\n \"offset_days\": 0\r\n },\r\n {\r\n \"cron_preset\": \"CRON_EVERY_WEEK\",\r\n \"cron_type\": \"week\",\r\n \"cron_interval\": 1,\r\n \"cron_start_of_day\": \"00:00:00\",\r\n \"cron_interval_start\": 1,\r\n \"time_range_preset\": 0,\r\n \"time_range_preset_label\": \"Fixed Time Range\",\r\n \"delta_type\": 1,\r\n \"delta_interval\": 1,\r\n \"delta_start_of_day\": \"00:00:00\",\r\n \"delta_interval_start\": 1,\r\n \"fixed_start\": \"2021-12-01\",\r\n \"fixed_end\": \"2021-12-02\",\r\n \"offset_days\": 0\r\n }\r\n]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"59f369a1-744f-4a66-924b-d19670abee9b"},{"name":"View existing schedules","id":"44abc12d-3d0c-462d-b42c-9c832228389a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/schedules","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","schedules"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"44abc12d-3d0c-462d-b42c-9c832228389a"},{"name":"Trigger all scheduled jobs","id":"ad359308-3e59-404c-848d-6cb0cde9a5de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"start\":\"YYYY-MM-DDTHH:MM:SSZ\",\r\n \"end\":\"YYYY-MM-DDTHH:MM:SSZ\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/fetch/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","fetch",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad359308-3e59-404c-848d-6cb0cde9a5de"},{"name":"Retrieve schedule and date range options for a datastream","id":"fcb1a46c-760c-4c8e-8ae2-22d2bf95af48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fcb1a46c-760c-4c8e-8ae2-22d2bf95af48"},{"name":"Edit schedule and date range configuration of a datastream","id":"43edb30b-c5ea-45ad-9137-f199270c622b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"time_range_preset\": 11,\r\n \"cron_type\": \"week\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"43edb30b-c5ea-45ad-9137-f199270c622b"}],"id":"18c16b7c-c534-45ca-a549-d0b240bacecf","_postman_id":"18c16b7c-c534-45ca-a549-d0b240bacecf","description":""},{"name":"Listing jobs and issues","item":[{"name":"List jobs","id":"8ee93960-88cb-469e-a71a-3fd9e5d27b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/","urlObject":{"protocol":"https","path":["api","jobs",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ee93960-88cb-469e-a71a-3fd9e5d27b70"},{"name":"List jobs of a datastream","id":"f9ea62ca-edb1-4145-b678-8906e0020393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/?datastream_id={{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","jobs",""],"host":["{{INSTANCE}}"],"query":[{"key":"datastream_id","value":"{{DATASTREAM_ID}}/"}],"variable":[]}},"response":[],"_postman_id":"f9ea62ca-edb1-4145-b678-8906e0020393"},{"name":"List jobs within a date range","id":"86d9b2e9-46b7-4000-a09e-e314ae14123d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/?start=YYYY-MM-DD&end=YYYY-MM-DD","urlObject":{"protocol":"https","path":["api","jobs",""],"host":["{{INSTANCE}}"],"query":[{"key":"start","value":"YYYY-MM-DD"},{"key":"end","value":"YYYY-MM-DD"}],"variable":[]}},"response":[],"_postman_id":"86d9b2e9-46b7-4000-a09e-e314ae14123d"},{"name":"List jobs within a time range","id":"9c61a4fe-26c1-4dc4-bee4-017b1ec86c3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/?start=YYYY-MM-DDT00:00:00Z&end=YYYY-MM-DDT00:00:00Z","urlObject":{"protocol":"https","path":["api","jobs",""],"host":["{{INSTANCE}}"],"query":[{"key":"start","value":"YYYY-MM-DDT00:00:00Z"},{"key":"end","value":"YYYY-MM-DDT00:00:00Z"}],"variable":[]}},"response":[],"_postman_id":"9c61a4fe-26c1-4dc4-bee4-017b1ec86c3e"},{"name":"List jobs of a type","id":"55faccae-ac00-4bd7-bc40-c1be03c52c44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/?type=Fetch/Enrich/Transfer","urlObject":{"protocol":"https","path":["api","jobs",""],"host":["{{INSTANCE}}"],"query":[{"key":"type","value":"Fetch/Enrich/Transfer"}],"variable":[]}},"response":[],"_postman_id":"55faccae-ac00-4bd7-bc40-c1be03c52c44"},{"name":"View the status of a job in progress","id":"70269d11-2071-40bc-aeef-94c92de75d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/{{JOB_ID}}/imported/","urlObject":{"protocol":"https","path":["api","jobs","{{JOB_ID}}","imported",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"70269d11-2071-40bc-aeef-94c92de75d42"},{"name":"Stop a job","id":"8efebb62-b176-48eb-8270-c6c09d8e9db5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token/ {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/jobs/{{JOB_ID}}/stop/","urlObject":{"protocol":"https","path":["api","jobs","{{JOB_ID}}","stop",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8efebb62-b176-48eb-8270-c6c09d8e9db5"},{"name":"List errors","id":"6f324df0-bd64-4c11-bba6-151ee70e7e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/errors/","urlObject":{"protocol":"https","path":["api","errors",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f324df0-bd64-4c11-bba6-151ee70e7e8d"},{"name":"List errors for a datastream","id":"cfadd1b9-06b8-443f-96d5-5015aebb528d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/errors/?datastream_id={{DATASTREAM_ID}}","urlObject":{"protocol":"https","path":["api","errors",""],"host":["{{INSTANCE}}"],"query":[{"key":"datastream_id","value":"{{DATASTREAM_ID}}"}],"variable":[]}},"response":[],"_postman_id":"cfadd1b9-06b8-443f-96d5-5015aebb528d"}],"id":"287dad09-dc8e-476f-9e25-6c639d3493d8","_postman_id":"287dad09-dc8e-476f-9e25-6c639d3493d8","description":""},{"name":"Data Mapping","item":[{"name":"List all columns","id":"bd6e036b-0ed2-4dc0-b39f-0af79c926123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/columns/","urlObject":{"protocol":"https","path":["api","columns",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd6e036b-0ed2-4dc0-b39f-0af79c926123"},{"name":"List all columns in a datastream","id":"84d4f7b4-c549-4289-a935-1bb5b53f40ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/columns/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","columns",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"84d4f7b4-c549-4289-a935-1bb5b53f40ad"},{"name":"View details of a column","id":"4beb5c99-6cf8-4250-bd2e-2db992a3fb86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/columns/{{COLUMN_ID}}","urlObject":{"protocol":"https","path":["api","columns","{{COLUMN_ID}}"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4beb5c99-6cf8-4250-bd2e-2db992a3fb86"},{"name":"List all target columns","id":"f17b2fbd-67a5-42cc-ae69-d7d44eb1d803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-columns/","urlObject":{"protocol":"https","path":["api","target-columns",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f17b2fbd-67a5-42cc-ae69-d7d44eb1d803"},{"name":"Find a target column by name","id":"38178539-1747-44f5-904b-091ca1bef5d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-columns/?stack_id={{STACK_ID}}&name={{COLUMN_NAME}}","urlObject":{"protocol":"https","path":["api","target-columns",""],"host":["{{INSTANCE}}"],"query":[{"key":"stack_id","value":"{{STACK_ID}}"},{"key":"name","value":"{{COLUMN_NAME}}"}],"variable":[]}},"response":[],"_postman_id":"38178539-1747-44f5-904b-091ca1bef5d3"},{"name":"Retrieve options for target columns","id":"f3708738-237c-4f8d-b675-fdd8523c954e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-columns/","urlObject":{"protocol":"https","path":["api","target-columns",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3708738-237c-4f8d-b675-fdd8523c954e"},{"name":"Create a new target column","id":"47bbb075-cc72-49a0-b896-f10a49e5a228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TYPE\",\r\n \"name\": \"NEW_COLUMN_NAME\",\r\n \"stack\": {{STACK_ID}},\r\n \"usage\": \"dimension/metric\"\r\n}"},"url":"https://{{INSTANCE}}/api/target-columns/","urlObject":{"protocol":"https","path":["api","target-columns",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47bbb075-cc72-49a0-b896-f10a49e5a228"},{"name":"View Data Mapping for a target field","id":"4d984d41-9cdf-4980-beb6-2a1fb5c2494f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"type\": \"TYPE\", \"name\": \"NEW_DATA_SCHEMA_COLUMN\", \"stack\": STACK_ID}"},"url":"https://{{INSTANCE}}/api/target-columns/{{TARGET_COLUMN_ID}}/mappings/","urlObject":{"protocol":"https","path":["api","target-columns","{{TARGET_COLUMN_ID}}","mappings",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d984d41-9cdf-4980-beb6-2a1fb5c2494f"},{"name":"Set Data Mapping for a column","id":"48d2fa80-3494-44f9-b98c-e6ee8565d1e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"is_key_column\":\"false\",\r\n \"set_default\": \"false\",\r\n \"target_column\": {\"id\": {{TARGET_COLUMN_ID}}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastreams/{{DATASTREAM_ID}}/columns/{{COLUMN_ID}}/","urlObject":{"protocol":"https","path":["api","datastreams","{{DATASTREAM_ID}}","columns","{{COLUMN_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"48d2fa80-3494-44f9-b98c-e6ee8565d1e3"}],"id":"b467cf64-00fa-498b-a7b9-6bddc07e8bbd","event":[{"listen":"prerequest","script":{"id":"ce9ac317-5b16-4621-9ba8-b60fd3b4b0dc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f8bb90a-0f83-46d1-90d2-b31fb391c6ad","type":"text/javascript","exec":[""]}}],"_postman_id":"b467cf64-00fa-498b-a7b9-6bddc07e8bbd","description":""},{"name":"Transformations (including mapping tables)","item":[{"name":"List all transformations","id":"76e66161-d728-49f5-96e8-8e41ea12175a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/transformer/","urlObject":{"protocol":"https","path":["api","transformer",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e66161-d728-49f5-96e8-8e41ea12175a"},{"name":"View instructions for a single transformation","id":"6fccda8e-b90d-44f1-a4d3-22ef68b09371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/transformer/{{TRANSFORMER_ID}}","urlObject":{"protocol":"https","path":["api","transformer","{{TRANSFORMER_ID}}"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fccda8e-b90d-44f1-a4d3-22ef68b09371"},{"name":"Create a new transformation","id":"14a26766-3fad-402e-be5c-40e94b829cac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"NEW_TRANSFORMATION\",\r\n \"stack\": {{STACK_ID}},\r\n \"instructions\": [\r\n\t\t[\r\n\t\t\"select\",\r\n\t\t\t{\r\n\t\t\t\"complement\": false,\r\n\t\t\t\"subtable\": null,\r\n\t\t\t\"where\": \"{COLUMN}\",\r\n\t\t\t\"_comment\": null\r\n\t\t\t}\r\n\t\t]\r\n\t]\r\n}"},"url":"https://{{INSTANCE}}/api/transformer/","urlObject":{"protocol":"https","path":["api","transformer",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14a26766-3fad-402e-be5c-40e94b829cac"},{"name":"Edit an existing transformation","id":"3b536cd5-968f-405d-b996-940ce67a7930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"{{NEW_NAME}}\"}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/transformer/{{TRANSFORMER_ID}}/","urlObject":{"protocol":"https","path":["api","transformer","{{TRANSFORMER_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b536cd5-968f-405d-b996-940ce67a7930"},{"name":"Delete a transformation","id":"dde2d2b9-5b78-4ab6-bbbc-ee2e231cd276","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/transformer/{{TRANSFORMER_ID}}/","urlObject":{"protocol":"https","path":["api","transformer","{{TRANSFORMER_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dde2d2b9-5b78-4ab6-bbbc-ee2e231cd276"},{"name":"List all mapping tables","id":"39ee1629-b3f5-4767-98d0-d5b4195713cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/mapping-tables","urlObject":{"protocol":"https","path":["api","mapping-tables"],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"39ee1629-b3f5-4767-98d0-d5b4195713cc"},{"name":"View all entries of a mapping table","id":"1b09420a-cc8c-4088-a8e3-86b3df7a2682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/mapping-tables/{{MAPPING_TABLE_ID}}/entries/","urlObject":{"protocol":"https","path":["api","mapping-tables","{{MAPPING_TABLE_ID}}","entries",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b09420a-cc8c-4088-a8e3-86b3df7a2682"},{"name":"Create a new mapping table entry","id":"4b16380c-d7ea-4cd4-9ade-d7ff4706b7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"match\": \"SOURCE_VALUE\",\r\n \"value\": \"TARGET_VALUE\"\r\n}"},"url":"https://{{INSTANCE}}/api/mapping-tables/{{MAPPING_TABLE_ID}}/entries/","urlObject":{"protocol":"https","path":["api","mapping-tables","{{MAPPING_TABLE_ID}}","entries",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b16380c-d7ea-4cd4-9ade-d7ff4706b7b6"},{"name":"Edit a mapping table entry","id":"4cb34e95-6933-4d4b-a2be-571c32e08216","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"value\": \"UPDATED_VALUE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/mapping-tables/{{MAPPING_TABLE_ID}}/entries/{{ENTRY_ID}}/","urlObject":{"protocol":"https","path":["api","mapping-tables","{{MAPPING_TABLE_ID}}","entries","{{ENTRY_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4cb34e95-6933-4d4b-a2be-571c32e08216"},{"name":"Delete a mapping table entry","id":"c7006ec3-025b-4984-b9eb-b6e27b788f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/mapping-tables/{{MAPPING_TABLE_ID}}/entries/{{ENTRY_ID}}/","urlObject":{"protocol":"https","path":["api","mapping-tables","{{MAPPING_TABLE_ID}}","entries","{{ENTRY_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7006ec3-025b-4984-b9eb-b6e27b788f9b"},{"name":"List all value tables","id":"0c1d4e70-f1b0-44c0-bff4-1893f89a5ba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/value-tables/","urlObject":{"protocol":"https","path":["api","value-tables",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c1d4e70-f1b0-44c0-bff4-1893f89a5ba1"}],"id":"5a1fdd1d-4301-42e4-8d19-7e1dd78f898d","_postman_id":"5a1fdd1d-4301-42e4-8d19-7e1dd78f898d","description":""},{"name":"Destinations","item":[{"name":"List all destination types","id":"71dfde8d-dfbb-42fe-a5e0-818930d5d939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/","urlObject":{"protocol":"https","path":["api","target-types",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"71dfde8d-dfbb-42fe-a5e0-818930d5d939"},{"name":"Retrieve options for a destination type","id":"9eb92cf5-c01f-4943-a425-7206ce756622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9eb92cf5-c01f-4943-a425-7206ce756622"},{"name":"List all destinations of a type","id":"2e61697f-719f-4a01-b250-1e95ca9d57e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e61697f-719f-4a01-b250-1e95ca9d57e5"},{"name":"Delete a destination","id":"51b94d5a-9688-4f2d-8cdb-62e7d1a18618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51b94d5a-9688-4f2d-8cdb-62e7d1a18618"},{"name":"List datastreams with a specific destination assigned","id":"27ccdcdc-8886-419f-80a6-ccd21a2d366d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"27ccdcdc-8886-419f-80a6-ccd21a2d366d"},{"name":"Retrieve options to configure destination's assignment to a datastream","id":"0dc875e6-eeaf-4873-a039-a17e77f9d623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0dc875e6-eeaf-4873-a039-a17e77f9d623"},{"name":"Assign destination to a datastream","id":"86f29ead-4fff-4978-a2b1-01cd3abd73a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"datastream\": {{DATASTREAM_ID}},\r\n \"table_name\": \"TABLE_MAPPING_NAME\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86f29ead-4fff-4978-a2b1-01cd3abd73a2"},{"name":"Edit the assignment of a destination to a datastream","id":"5d95efa3-89f6-4e2f-a346-b78a3bd5ab05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": {{MAPPING_ID}},\r\n \"target\": {{TARGET_ID}},\r\n \"datastream\": {{DATASTREAM_ID}},\r\n \"table_name\": \"TABLE_MAPPING_NAME\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{MAPPING_ID}}/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings","{{MAPPING_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d95efa3-89f6-4e2f-a346-b78a3bd5ab05"},{"name":"Enable a destination assigned to a datastream","id":"1e1c46de-d782-47c7-891e-566743ba879e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": {{MAPPING_ID}},\r\n \"target\": {{TARGET_ID}},\r\n \"datastream\": {{DATASTREAM_ID}},\r\n \"table_name\": \"TABLE_MAPPING_NAME\",\r\n \"enabled\": \"True\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{MAPPING_ID}}/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings","{{MAPPING_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e1c46de-d782-47c7-891e-566743ba879e"},{"name":"Enable all destinations assigned to a datastream","id":"120bcde7-0963-4a96-bcd7-0e9674af7bd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"datatype\": \"Live\"}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/datastream-types/{{DATASTREAM_TYPE}}/datastreams/{{DATASTREAM_ID}}/","urlObject":{"protocol":"https","path":["api","datastream-types","{{DATASTREAM_TYPE}}","datastreams","{{DATASTREAM_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"120bcde7-0963-4a96-bcd7-0e9674af7bd7"},{"name":"Delete the assignment of a destination to a datastream","id":"9feaf2cc-4bb2-4645-8b70-2528de61e7ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"datastream\": {{DATASTREAM_ID}},\r\n \"table_name\": \"TABLE_MAPPING_NAME\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/{{TARGET_ID}}/mappings/{{MAPPING_ID}}/","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets","{{TARGET_ID}}","mappings","{{MAPPING_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9feaf2cc-4bb2-4645-8b70-2528de61e7ee"},{"name":"Create a destination","id":"31636975-9867-47cd-b93b-7dadfd82df06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"NEW_DESTINATION_NAME\",\r\n \"stack\": {{STACK_ID}},\r\n \"auth\": {{CONNECTION_ID}}\r\n}"},"url":"https://{{INSTANCE}}/api/target-types/{{TARGET_TYPE_ID}}/targets/","description":"Depending on which type was chosen, the required parameters placed within the body will vary.
\n","urlObject":{"protocol":"https","path":["api","target-types","{{TARGET_TYPE_ID}}","targets",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"31636975-9867-47cd-b93b-7dadfd82df06"}],"id":"c4f46797-db7e-45de-bb73-c050e0af8aea","_postman_id":"c4f46797-db7e-45de-bb73-c050e0af8aea","description":""},{"name":"User management","item":[{"name":"List all users","id":"78c21e9d-ad64-42f1-8468-111d6dc478d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/v1/users/?page=1&page_size=50","urlObject":{"protocol":"https","path":["api","v1","users",""],"host":["{{INSTANCE}}"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"}],"variable":[]}},"response":[],"_postman_id":"78c21e9d-ad64-42f1-8468-111d6dc478d5"},{"name":"Create a new user","id":"681ec4be-f824-4678-a73a-dad67db3512f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@example.com\",\r\n \"first_name\": \"string\",\r\n \"last_name\": \"string\",\r\n \"groups\": [],\r\n \"workspaces\": [],\r\n \"active\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/v1/users/","urlObject":{"protocol":"https","path":["api","v1","users",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"681ec4be-f824-4678-a73a-dad67db3512f"},{"name":"View a user","id":"8a267647-d63d-496e-8cb8-14a06f91ca29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/v1/users/{{USER_ID}}/","urlObject":{"protocol":"https","path":["api","v1","users","{{USER_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a267647-d63d-496e-8cb8-14a06f91ca29"},{"name":"Edit a user","id":"a021de69-e3ae-4059-8cfc-7c531df059da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@example.com\",\r\n \"first_name\": \"string\",\r\n \"last_name\": \"string\",\r\n \"groups\": [],\r\n \"workspaces\": [],\r\n \"active\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/v1/users/{{USER_ID}}/","urlObject":{"protocol":"https","path":["api","v1","users","{{USER_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a021de69-e3ae-4059-8cfc-7c531df059da"},{"name":"Delete a user","id":"fb241f39-35ba-475a-beb9-2d45ff8d3c3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/v1/users/{{USER_ID}}/","urlObject":{"protocol":"https","path":["api","v1","users","{{USER_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb241f39-35ba-475a-beb9-2d45ff8d3c3e"}],"id":"2a3ba0cc-f693-4d0d-8d96-f9fb674e6906","_postman_id":"2a3ba0cc-f693-4d0d-8d96-f9fb674e6906","description":""},{"name":"Notifications","item":[{"name":"List all email notifications","id":"3b02e83d-7c5e-4bb3-917c-f090724ada5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/email/","urlObject":{"protocol":"https","path":["api","notifications","email",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b02e83d-7c5e-4bb3-917c-f090724ada5d"},{"name":"View a specific email notification details","id":"12f51c61-9988-4821-93ae-e1d58b13ebac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/email/{{EMAIL_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","email","{{EMAIL_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12f51c61-9988-4821-93ae-e1d58b13ebac"},{"name":"Create a new email notification","id":"08387c9e-a373-4223-aa00-cd99da69fcc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"topics\":[\n\t \"ABC\"\n\t], \n\t\"stacks\": [\"STACK_ID\"],\n \"email\": \"RECIPIENT@DOMAIN.com\"\n\t\n}"},"url":"https://{{INSTANCE}}/api/notifications/email/","urlObject":{"protocol":"https","path":["api","notifications","email",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"08387c9e-a373-4223-aa00-cd99da69fcc9"},{"name":"Edit an email notification","id":"4e7ef269-ee10-4ebc-8fe7-afb5ac9acf16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"NEW_RECIPIENT@DOMAIN.COM\"}"},"url":"https://{{INSTANCE}}/api/notifications/email/{{EMAIL_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","email","{{EMAIL_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e7ef269-ee10-4ebc-8fe7-afb5ac9acf16"},{"name":"Delete an email notification","id":"fc702ea4-71a7-463f-847e-393ccb7bbde3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/email/{{EMAIL_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","email","{{EMAIL_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc702ea4-71a7-463f-847e-393ccb7bbde3"},{"name":"List all Slack notifications","id":"505ef71d-e1b2-4e4e-a893-9ed8f5436f5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/slack/","urlObject":{"protocol":"https","path":["api","notifications","slack",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"505ef71d-e1b2-4e4e-a893-9ed8f5436f5c"},{"name":"View a specific Slack notification details","id":"cabf5152-4a6a-4ef8-a29a-9b1417ccd6a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/slack/{{SLACK_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","slack","{{SLACK_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cabf5152-4a6a-4ef8-a29a-9b1417ccd6a0"},{"name":"Create a new Slack notification","id":"ce120799-6d3b-42db-8f7b-173ccf283548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"webhook_url\": \"https://hooks.slack.com/services/VALID_WEBHOOK_ID\",\r\n \"topics\": [\"ABC\", \"XYZ\"]}"},"url":"https://{{INSTANCE}}/api/notifications/slack/","urlObject":{"protocol":"https","path":["api","notifications","slack",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce120799-6d3b-42db-8f7b-173ccf283548"},{"name":"Edit a Slack notification","id":"a070b650-7b40-435e-973e-7b38ee96ac51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"datastreams\": [DATASTREAM_ID]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/notifications/slack/{{SLACK_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","slack","{{SLACK_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a070b650-7b40-435e-973e-7b38ee96ac51"},{"name":"Delete a Slack notification","id":"7feb3807-ecd7-43c9-ba61-5584f499ea1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/slack/{{SLACK_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","slack","{{SLACK_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7feb3807-ecd7-43c9-ba61-5584f499ea1b"},{"name":"List all Microsoft Teams notifications","id":"b4d58ce7-799c-4c51-9b88-9a0eeff2e052","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/microsoftteams/","urlObject":{"protocol":"https","path":["api","notifications","microsoftteams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4d58ce7-799c-4c51-9b88-9a0eeff2e052"},{"name":"View a specific Microsoft Teams notification details","id":"9b286135-97c5-4c66-9d6a-c31218c4cb01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/microsoftteams/{{MICROSOFT_TEAMS_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","microsoftteams","{{MICROSOFT_TEAMS_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b286135-97c5-4c66-9d6a-c31218c4cb01"},{"name":"Create a new Microsoft Teams notification","id":"9cf6af77-2d93-4f0e-b522-3b2c2eb65b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"webhook_url\": \"https://WEBHOOK_URL/VALID_WEBHOOK_ID\",\r\n \"topics\": [\r\n \"ABC\",\r\n \"XYZ\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/notifications/microsoftteams/","urlObject":{"protocol":"https","path":["api","notifications","microsoftteams",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cf6af77-2d93-4f0e-b522-3b2c2eb65b9e"},{"name":"Edit a Microsoft Teams notification","id":"c18cd58b-7f2f-45d6-bcbe-f4272c4eebde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"datastreams\": [DATASTREAM_ID]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{INSTANCE}}/api/notifications/microsoftteams/{{MICROSOFT_TEAMS_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","microsoftteams","{{MICROSOFT_TEAMS_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c18cd58b-7f2f-45d6-bcbe-f4272c4eebde"},{"name":"Delete a Microsoft Teams notification","id":"79251276-390e-4fd4-b884-b21e23a913cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{KEY}}"},{"key":"Authorization","value":"Bearer {{KEY}}"}],"url":"https://{{INSTANCE}}/api/notifications/microsoftteams/{{MICROSOFT_TEAMS_NOTIFICATION_ID}}/","urlObject":{"protocol":"https","path":["api","notifications","microsoftteams","{{MICROSOFT_TEAMS_NOTIFICATION_ID}}",""],"host":["{{INSTANCE}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"79251276-390e-4fd4-b884-b21e23a913cf"}],"id":"a5f6d54a-4bef-4196-b609-a630447b7d87","event":[{"listen":"prerequest","script":{"id":"17ce7f8e-1ede-413f-8c60-efd20ad29e9b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"516314ed-3f57-4a94-b376-22a2769039dd","type":"text/javascript","exec":[""]}}],"_postman_id":"a5f6d54a-4bef-4196-b609-a630447b7d87","description":""},{"name":"Response Codes","item":[],"id":"29885ed5-d827-4230-a87d-1121f1792865","description":"You will encounter the following response codes:
\n200: success
\n201: resource created successfuly
\n204: resource deleted successfuly
\n301: redirect (all endpoints have to be accessed with a trailing slash)
\n400: bad request (please refer to the response body for detailed explanation)
\n401/403: authorization error or missing permission to requested resource (please refer to the response body for detailed explanation)
\n404: requested endpoint or resource not found
\n413: Filesize limit exceeded (only for /api/datastreams//extracts/streaming/download)
\n500: server error: Please contact Support.
\n