Segment APIs enable you to collect customer data and send it to any destination you want.
\nThe Config API is a set of REST APIs that enable you to programmatically manage Segment workspaces, sources, destinations and more.
\nThis documents all the REST API methods, with example requests and responses. You can also load this into the Postman API Development Environment to interact with the API with your own access tokens.
\nWith the Config API you can:
\nList all your workspace sources and destinations to see how data flows through Segment
\nCreate new sources to collect data from your website, mobile app or server
\nCreate new destinations to send data to your analytics service or data warehouse
\nEnable and disable destinations to route data without code changes
\nConfigure a tracking plan to see how data conforms to your expected schema
\nIf there are other uses cases you'd like the API to support, get in touch.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37707780","collectionId":"c88336c1-101b-4ceb-b339-21f904810db4","publishedId":"2sAYX3q36f","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-17T19:33:12.000Z"},"item":[{"name":"Access Tokens","item":[],"id":"35a2ba94-bd16-4e85-ab5d-63ca42d3a43d","description":"To create an access token, workspace owners can navigate to \"Access Management\" within the settings tab and assign permissions and resources to new tokens. More details here: https://segment.com/docs/config-api/
\nIf your workspace is running in the EU, please access https://api.segmentapis.com/docs/ for API documentation.
\n","_postman_id":"35a2ba94-bd16-4e85-ab5d-63ca42d3a43d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}}},{"name":"Integrations Catalog","item":[{"name":"List Catalog Sources","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","id":"88e56d9d-89bf-4c9b-a133-13ddb0d0162b"}}],"id":"c87a73d3-dba9-453c-9182-eb439fc33807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/catalog/sources?page_size=&page_token=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","catalog","sources"],"host":["https://platform.segmentapis.com"],"query":[{"description":{"content":"Optional, e.g. 2
Optional, e.g. eyJTa2lwIjoyfQ==
Optional, e.g. 2
Optional, e.g. NTQ1MjFmZDUyNWU3MjFlMzJhNzJlZTkw
Integrations Catalog APIs list all the sources, destinations and destination settings supported by Segment.
\nname is used when creating a source.
Optional, e.g. 2
Optional, e.g. MjAxNi0wNC0yOVQxNTo0OTozMi40Wg==
Retrieves the schema configuration for a source. If protocols is not enabled for the source then the configurations specific to protocols will have default values.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js","schema-config"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"2750c53f-386a-44d1-b556-369e537997a3","name":"Get Schema Configuration for protocols disabled source","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config?=","host":["https://platform.segmentapis.com"],"path":["v1beta","workspaces/myworkspace/sources/js","schema-config"],"query":[{"key":"","value":"","description":"Retrieves the schema configuration for a source. If protocols is not enabled for the source then the configurations specific to protocols will have default values."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2019 21:19:14 GMT"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": true,\n \"allow_unplanned_identify_traits\": false,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": false,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": false,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"\"\n}"},{"id":"abffa654-095c-4718-bbf3-8ece793701e4","name":"Get Schema Configuration for protocols enabled source","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config?=","host":["https://platform.segmentapis.com"],"path":["v1beta","workspaces/myworkspace/sources/js","schema-config"],"query":[{"key":"","value":"","description":"Retrieves the schema configuration for a source. If protocols is not enabled for the source then the configurations specific to protocols will have default values."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 02 May 2019 21:19:14 GMT"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": true,\n \"allow_unplanned_identify_traits\": false,\n \"allow_unplanned_group_traits\": true,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": true,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": true,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"forwarding_violations_to_source_slug\",\n \"common_track_event_on_violations\": \"ALLOW\",\n \"common_identify_event_on_violations\": \"OMIT_TRAITS\",\n \"common_group_event_on_violations\": \"BLOCK\",\n}"}],"_postman_id":"a569a00e-d08e-4a7b-bd3b-b637d6883a45"},{"name":"Update Schema Configuration","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Segment Engineering","// Defer calling \"Delete Source\" until the end","postman.setNextRequest(\"Create Destination\");"],"type":"text/javascript","id":"12f76da0-f2c3-4e2b-89b1-ba965feef500"}}],"id":"5419741c-a88c-4fd3-803e-fb5ba6cec5e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schema_config\": {\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"\",\n \"allow_unplanned_track_event_properties\": true,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": true,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"\",\n \"allow_track_properties_on_violations\": false,\n \"common_track_event_on_violations\": \"OMIT_PROPERTIES\",\n\t\"common_identify_event_on_violations\": \"OMIT_TRAITS\",\n\t\"common_group_event_on_violations\": \"BLOCK\"\n },\n \"update_mask\": {\n \"paths\": [\n \"schema_config.allow_unplanned_track_events\",\n \"schema_config.allow_unplanned_identify_traits\",\n \"schema_config.allow_unplanned_group_traits\",\n \"schema_config.forwarding_blocked_events_to\",\n \"schema_config.allow_unplanned_track_event_properties\",\n \"schema_config.allow_track_event_on_violations\",\n \"schema_config.allow_identify_traits_on_violations\",\n \"schema_config.allow_group_traits_on_violations\",\n \"schema_config.forwarding_violations_to\",\n \"schema_config.allow_track_properties_on_violations\",\n \"schema_config.common_track_event_on_violations\",\n \"schema_config.common_identify_event_on_violations\",\n \"schema_config.common_group_event_on_violations\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config","description":"Updates the schema configuration for a source. If protocols is not enabled for the source then any updates to protocols specific configurations will not be applied.
\nCommon JSON schema settings accept the parameters \"ALLOW\", \"OMIT_PROPERTIES\" for Track Events, \"OMIT_TRAITS\" for Identify & Group Events, and \"BLOCK\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js","schema-config"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"cfdb8dfe-3451-4457-8f47-39b6ad01e85f","name":"Update Schema Configuration for a Protocols Enabled Source","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schema_config\": {\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": true,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": true,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"forwarding_violations_to_source_slug\",\n \"common_track_event_on_violations\": \"ALLOW\",\n\t\"common_identify_event_on_violations\": \"ALLOW\",\n\t\"common_group_event_on_violations\": \"ALLOW\"\n },\n \"update_mask\": {\n \"paths\": [\n \"schema_config.allow_unplanned_track_events\",\n \"schema_config.allow_unplanned_identify_traits\",\n \"schema_config.allow_unplanned_group_traits\",\n \"schema_config.forwarding_blocked_events_to\",\n \"schema_config.allow_unplanned_track_event_properties\",\n \"schema_config.allow_track_event_on_violations\",\n \"schema_config.allow_identify_traits_on_violations\",\n \"schema_config.allow_group_traits_on_violations\",\n \"schema_config.forwarding_violations_to\",\n \"schema_config.common_track_event_on_violations\",\n \"schema_config.common_identify_event_on_violations\",\n \"schema_config.common_group_event_on_violations\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": true,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": true,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"forwarding_violations_to_source_slug\",\n \"allow_track_properties_on_violations\": false,\n \"common_track_event_on_violations\": \"ALLOW\",\n \"common_identify_event_on_violations\": \"ALLOW\",\n \"common_group_event_on_violations\": \"ALLOW\"\n}"},{"id":"270774b8-66e2-4a5d-8dba-f76746867f88","name":"Update Schema Configuration for a Protocols Disabled Source","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schema_config\": {\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\"\n },\n \"update_mask\": {\n \"paths\": [\n \"schema_config.allow_unplanned_track_events\",\n \"schema_config.allow_unplanned_identify_traits\",\n \"schema_config.allow_unplanned_group_traits\",\n \"schema_config.forwarding_blocked_events_to\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": false,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"forwarding_blocked_events_to_source_slug\",\n \"allow_unplanned_track_event_properties\": false,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": false,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"\",\n \"allow_track_properties_on_violations\": false,\n}"},{"id":"a243e594-a2df-42b1-b2be-02b2a8853c24","name":"Update Subset of Schema Configuration for a Protocols Enabled Source","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schema_config\": {\n \"allow_unplanned_track_events\": true,\n \"forwarding_blocked_events_to\": \"foo\",\n \"allow_unplanned_track_event_properties\": false,\n },\n \"update_mask\": {\n \"paths\": [\n \"schema_config.allow_unplanned_track_events\",\n \"schema_config.forwarding_blocked_events_to\",\n \"schema_config.allow_unplanned_track_event_properties\",\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/schema-config"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/schema-config\",\n \"parent\": \"sources/js\",\n \"allow_unplanned_track_events\": true,\n \"allow_unplanned_identify_traits\": true,\n \"allow_unplanned_group_traits\": false,\n \"forwarding_blocked_events_to\": \"foo\",\n \"allow_unplanned_track_event_properties\": false,\n \"allow_track_event_on_violations\": false,\n \"allow_identify_traits_on_violations\": true,\n \"allow_group_traits_on_violations\": false,\n \"forwarding_violations_to\": \"forwarding_violations_to_source_slug\",\n \"allow_track_properties_on_violations\": false,\n \"common_track_event_on_violations\": \"ALLOW\",\n \"common_identify_event_on_violations\": \"ALLOW\",\n \"common_group_event_on_violations\": \"ALLOW\"\n}"}],"_postman_id":"5419741c-a88c-4fd3-803e-fb5ba6cec5e0"},{"name":"Update Connected Warehouses","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Segment Engineering","// Defer calling \"Delete Source\" until the end","postman.setNextRequest(\"Create Destination\");"],"type":"text/javascript","id":"9e1a6d75-db5c-47db-8981-89ec02898f0a"}}],"id":"5eaa8dd3-a87c-47aa-bd91-bb0614434472","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"enabled\": false\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/connected-warehouses","description":"Disable or enable a source from syncing to a warehouse using the warehouse id. Use a for loop to update multiple source<>warehouse pairs.
\nNote: Only the following roles have permissions to execute the update request:
\n- Workspace Owner, or\n- Source Admin and Warehouse Admin\nIsLatestVersion is used to check whether a source instance is running the latest code from its associated source function class. It can be used to determine whether a Deploy is necessary to update the code. If IsLatestVersion is true, Deploy would be a no-op.
Deploy is used to update the code deployed for a source function instance. It loads the latest code from the associated function class (available in Functions API).
The name must be unique within the workspace. The catalog_name is available in the Source Catalog APIs. catalog_id can be used in place of catalog_name and is available in the Functions APIs.
Only applies to source functions.
\nExample :
\n function_config: [{\n \"name\": \"arraySetting\",\n \"value\": [\"a\", \"b\", \"c\"],\n\n },\n {\n \"name\": \"booleanSetting\",\n \"value\": true,\n },\n {\n \"name\": \"mapSetting\"\n \"value\": {\n \"key1\": \"val1\"\n },\n },\n {\n \"name\": \"sensitiveSetting\",\n \"value\": \"****\"\n },\n {\n \"name\": \"setting\",\n \"value\": \"string value\"\n }]```\nNote:
\nIf you attempt to update read-only settings for your destination you'll encounter the following behavior:
\nIf only read-only properties are being updated, the endpoint will return an HTTP 400 error.
\nIf there's a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored.
\nThe config options and name is available in the destination catalog APIs.\ncatalog_id can be used in place of catalog_name and is available in the Functions APIs for Destination Functions.
For destinations that support connection_mode, valid values are CLOUD or DEVICE.
It is expected that a tracking plan that includes a null enum value as a property field will denote that value as a string (\"null\"). See documented Get Tracking Plan With Null Enum call, and documented Update Tracking Plan With Null Enum calls for examples.
Note: does not currently support pagination.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","tracking-plans",""],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"21dcfa7f-2301-429c-9587-af1dfd4f5e5c","name":"List Tracking Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Oct 2018 21:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"8"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"tracking_plans\": [\n {\n \"name\": \"workspaces/myworkspace/tracking-plans/rs_123\",\n \"display_name\": \"Kicks App\",\n \"rules\": {\n \"identify_traits\": [],\n \"group_traits\": [],\n \"events\": []\n },\n \"create_time\": \"2019-02-05T00:28:31Z\",\n \"update_time\": \"2019-02-05T00:28:31Z\"\n }\n ]\n}"}],"_postman_id":"c288e169-e9ee-45b5-8e72-bf6dda8018a5"},{"name":"Update Tracking Plan","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"4c7ba580-05ea-4c0a-b7ee-c8bc1aadd701"}}],"id":"d33a6844-369b-4849-be4d-7573766bbfa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"update_mask\": {\n \"paths\": [\n \"tracking_plan.display_name\",\n \"tracking_plan.rules\"\n ]\n },\n \"tracking_plan\": {\n \"display_name\": \"Kicks App - Updated\",\n \"rules\": {\n \"global\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {\n \"type\": \"object\",\n \"properties\": {\n \"userAgent\": {}\n },\n \"required\": [\n \"userAgent\"\n ]\n }\n },\n \"required\": [\n \"context\"\n ]\n },\n \"events\": [\n {\n \"name\": \"Product Viewed\",\n \"description\": \"Who checked out what\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\"string\"]\n }\n },\n \"required\": [\n \"product\"\n ]\n }\n },\n \"required\": [\n \"properties\"\n ]\n }\n }\n ]\n }\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123","description":"To update a tracking plan field, include it in update_mask.paths. For example, if tracking_plan.rules is included in the paths array, existing rules will be replaced by rules specified in the request body. If a field is listed in the paths array, but is not included in the request body, it will be overwritten with an empty object.
It is expected that including a null enum value as a property field will return a tracking plan that denotes that value as a string (\"null\"). See documented example call.
Depending on the size of the tracking plan, the returned payload might not include the updated events. Use the GET endpoint or the UI instead.
\nEmojis are not currently supported in tracking plan JSON schemas.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"09fc8459-d139-4c46-b7cd-c4d114e337fa","name":"Update Tracking Plan","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"update_mask\": {\n \"paths\": [\n \"tracking_plan.display_name\",\n \"tracking_plan.rules\"\n ]\n },\n \"tracking_plan\": {\n \"display_name\": \"Kicks App - Updated\",\n \"rules\": {\n \"global\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {\n \"type\": \"object\",\n \"properties\": {\n \"userAgent\": {}\n },\n \"required\": [\n \"userAgent\"\n ]\n }\n },\n \"required\": [\n \"context\"\n ]\n },\n \"events\": [\n {\n \"name\": \"Product Viewed\",\n \"description\": \"Who checked out what\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\"string\"]\n }\n },\n \"required\": [\n \"product\"\n ]\n }\n },\n \"required\": [\n \"properties\"\n ]\n }\n }\n ]\n }\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Oct 2018 23:04:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1419"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"108"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/tracking-plans/rs_123\",\n \"display_name\": \"Kicks App - Updated\",\n \"rules\": {\n \"identify_traits\": [],\n \"group_traits\": [],\n \"events\": [\n {\n \"name\": \"Product Viewed\",\n \"version\": 1,\n \"description\": \"Who checked out what\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"traits\": {},\n \"properties\": {\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": [\n \"string\"\n ]\n }\n },\n \"required\": [\n \"product\"\n ]\n },\n \"context\": {}\n },\n \"required\": [\n \"properties\"\n ]\n }\n }\n ],\n \"global\": {\n \"required\": [\n \"context\"\n ],\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"context\": {\n \"type\": \"object\",\n \"properties\": {\n \"userAgent\": {}\n },\n \"required\": [\n \"userAgent\"\n ]\n },\n \"traits\": {},\n \"properties\": {}\n }\n }\n },\n \"create_time\": \"2019-02-05T00:28:31Z\",\n \"update_time\": \"2019-02-05T00:32:15Z\"\n}"},{"id":"057adc7c-3262-41ae-a716-dc899878cd73","name":"Update Tracking Plan With Null Enum","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer","type":"text"}],"body":{"mode":"raw","raw":"{\n \"update_mask\": {\n \"paths\": [\n \"tracking_plan.rules\"\n ]\n },\n \"tracking_plan\": {\n \"rules\": {\n \"identify_traits\": [],\n \"group_traits\": [],\n \"events\": [\n {\n \"name\": \"New Event\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"context\": {\n \"type\": \"object\"\n },\n \"properties\": {\n \"properties\": {\n \"item_description\": {\n \"description\": \"\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"item_name\": {\n \"description\": \"\",\n \"enum\": [\n null\n ],\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"type\": \"object\"\n },\n \"traits\": {\n \"type\": \"object\"\n }\n },\n \"type\": \"object\"\n },\n \"version\": 1\n }\n ],\n \"global\": null,\n \"identify\": null,\n \"group\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/business/tracking-plans/rs_1bxb4RSGi54Poxe5naPiiqswDXE\",\n \"display_name\": \"Kicks App\",\n \"rules\": {\n \"identify_traits\": [],\n \"group_traits\": [],\n \"events\": [\n {\n \"name\": \"New Event\",\n \"rules\": {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"context\": {\n \"type\": \"object\"\n },\n \"properties\": {\n \"properties\": {\n \"item_description\": {\n \"description\": \"\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"item_name\": {\n \"description\": \"\",\n \"enum\": [\n \"null\"\n ],\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"type\": \"object\"\n },\n \"traits\": {\n \"type\": \"object\"\n }\n },\n \"type\": \"object\"\n },\n \"version\": 1\n }\n ],\n \"global\": null,\n \"identify\": null,\n \"group\": null\n },\n \"create_time\": \"2020-05-15T21:01:39Z\",\n \"update_time\": \"2020-06-30T19:33:59Z\"\n}"}],"_postman_id":"d33a6844-369b-4849-be4d-7573766bbfa0"},{"name":"Batch Create Tracking Plan Source Connections","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"014b3caa-03ef-4324-81bc-6693510e23da"}}],"id":"4c699285-3562-4340-8855-fca9a843c3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"source_names\": [\"workspaces/myworkspace/sources/js\"]\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections:batchCreateConnections","description":"Connect existing sources to an existing tracking plan
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123","source-connections:batchCreateConnections"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"f95744ef-941d-447d-ac16-2663972229a1","name":"Batch Create Tracking Plan Source Connection","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"source_names\": [\"workspaces/myworkspace/sources/js\"]\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Oct 2018 21:27:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"41"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"connections\": [\n {\n \"source_name\": \"workspaces/myworkspace/sources/js\",\n \"tracking_plan_id\": \"rs_1Gjkh9ZKmpyHjdSZYaLTXRRgCPp\"\n }\n ]\n}"}],"_postman_id":"4c699285-3562-4340-8855-fca9a843c3d9"},{"name":"Create Tracking Plan Source Connection","event":[{"listen":"test","script":{"exec":["// Segment Engineering","// Don't fail if connection fails","pm.test(\"Status code is 200 or 503\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200,503]);","});"],"type":"text/javascript","id":"76ee981b-203a-4851-a318-a4f71421ebde"}}],"id":"50beef47-b4e1-4256-840e-9d9e1c04a5d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"source_name\": \"workspaces/myworkspace/sources/js\"\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections","description":"Connect existing sources to an existing tracking plan
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123","source-connections"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"788e31fb-2514-4e04-80c8-4020622400bc","name":"Create Tracking Plan Source Connection","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"source_name\": \"workspaces/myworkspace/sources/js\"\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Oct 2018 21:27:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"41"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"source_name\": \"workspaces/myworkspace/sources/js\",\n \"tracking_plan_id\": \"rs_1Gjkh9ZKmpyHjdSZYaLTXRRgCPp\"\n}"}],"_postman_id":"50beef47-b4e1-4256-840e-9d9e1c04a5d6"},{"name":"List Tracking Plan Source Connections","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"2b2ce817-59c0-45b6-b68f-9061c11ed1b8"}}],"id":"7e1ab838-a49a-4b87-8d1b-896ce346beae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections","description":"List all sources connected to this tracking plan.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123","source-connections"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"f648f681-8253-434c-9040-4b9e0b6e4db1","name":"List Tracking Plan Source Connections","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Oct 2018 21:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"8"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"connections\": [\n {\n \"source_name\": \"workspaces/myworkspace/sources/js\",\n \"tracking_plan_id\": \"rs_1Gjkh9ZKmpyHjdSZYaLTXRRgCPp\"\n }\n ]\n}"}],"_postman_id":"7e1ab838-a49a-4b87-8d1b-896ce346beae"},{"name":"Delete Tracking Plan Source Connection","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"65a1070d-d752-45ae-8f81-f1e4473710e3"}}],"id":"a5747d6e-1129-4c67-8ee6-72eb5e366597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections/{{source_slug}}","description":"Remove a source from this tracking plan.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123","source-connections","{{source_slug}}"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"5e7c612d-816a-488e-ae5a-94de0e31a8fd","name":"Delete Tracking Plan Source Connection","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123/source-connections/js"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Oct 2018 21:41:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"23"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"a5747d6e-1129-4c67-8ee6-72eb5e366597"},{"name":"Delete Tracking Plan","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"4fdff146-7a68-4d81-ae45-77f2a55abc32"}}],"id":"1697990b-e436-4acb-b755-46f13d9f1593","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/tracking-plans/rs_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"31969cb3-7830-45be-9e7f-6d4a515fc00e","name":"Delete Tracking Plan","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/tracking-plans/rs_123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Oct 2018 23:07:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"7"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"1697990b-e436-4acb-b755-46f13d9f1593"}],"id":"4698f0b7-abff-4281-8c22-6757c1d069ad","description":"Protocols APIs govern the data that flows through Segment. You can define a strict schema of event names and properties, track how the data conforms to this schema, and block non-conforming data from delivery to destinations.
\nEvery rule object is represented as JSON Schema.
\nGet timeseries data for a specific metric for a source-destination pair.
\nIf you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example request, List - Multi Destination Enabled, can be found in the Example requests dropdown. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","metrics","successes"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"b8f3c3c1-4e55-4399-a6ae-153044192685","name":"Get","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 170519,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 166422,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n}"},{"id":"7eaf8aaa-eb22-49cf-98b5-11be23a60a60","name":"Get - Multi Destination Enabled","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/confiig/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successe"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes\",\n \"granularity\": \"DAY\"\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 170519,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 166422,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n}"}],"_postman_id":"e93fd8e4-72ce-4089-8bb0-5a6d40492fc1"},{"name":"List Metric Timeseries","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 404\", function () {"," pm.response.to.have.status(404);","});","","pm.test(\"Error message is no metrics found\", function() {"," var r = pm.response.json();"," pm.expect(r.error).to.include(\"no metrics found for the given source\");","});",""],"type":"text/javascript","id":"02c34df0-d026-48b6-942a-0584a6a1418f"}}],"id":"7366208f-2b0b-4314-9257-90ee1d24d197","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics","description":"Timeseries data for all metrics for a source-destination pair.
\nIf you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example in List - Multi Destination Enabled in the Example requests. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","metrics"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"07d13d3a-0b50-4368-8282-4023f59debc6","name":"List Event Delivery Metrics","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metrics\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/expired\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 1319,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 38,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 20,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 21,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 19,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_502\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 17,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 10,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 19,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_504\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 21,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 1,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 2,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 11,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_ECONNABORTED\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 1,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 170519,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 166929,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes_after_retry\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 3596,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3442,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 4006,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3697,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 3496,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3637,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes_on_first_attempt\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 169019,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 167167,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 166662,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 166725,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 167023,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 163292,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_first_attempt_average\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 5.502818496,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3.706166541,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 3.228996959,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3.517764604,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 4.645016078,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3.495370896,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_first_attempt_p95\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 3.055067164,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3.063505857,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 3.149659938,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3.482212419,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 3.8428379,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3.453382997,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"next_page_token\": \"dGltZV90b19zdWNjZXNzX2F2ZXJhZ2U=\"\n}"},{"id":"43a9fd39-626a-496e-b004-c00ac6e4088a","name":"List Event Delivery Metrics - Multi Destination Enabled","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics","protocol":"https","host":["platform","segmentapis","com"],"path":["v1beta","workspaces","myworkspace","sources","js","destinations","google-analytics","config","1a2b3c5d6e7f8g9h0i1a2b3c5","metrics"],"query":[{"key":"","value":"","disabled":true},{"key":"","value":null,"disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metrics\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/expired\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 1319,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 38,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 20,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 21,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 19,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_502\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 17,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 10,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 19,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_504\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 21,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 1,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 2,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 11,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_ECONNABORTED\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 1,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 0,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 170519,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 166929,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_after_retry\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 3596,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3442,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 4006,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3697,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 3496,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3637,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_on_first_attempt\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 169019,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 167167,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 166662,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 166725,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 167023,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 163292,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_average\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 5.502818496,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3.706166541,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 3.228996959,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3.517764604,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 4.645016078,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3.495370896,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_p95\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 3.055067164,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 3.063505857,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 3.149659938,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 3.482212419,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"value\": 3.8428379,\n \"timestamp\": \"2019-01-24T00:00:00Z\"\n },\n {\n \"value\": 3.453382997,\n \"timestamp\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n }\n ],\n \"next_page_token\": \"dGltZV90b19zdWNjZXNzX2F2ZXJhZ2U=\"\n}"}],"_postman_id":"7366208f-2b0b-4314-9257-90ee1d24d197"},{"name":"Batch Get Metric Timeseries","event":[{"listen":"test","script":{"exec":["// Segment Engineering","// Don't fail on validation error","pm.test(\"Status code is 200 or 400\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200,400]);","});",""],"type":"text/javascript","id":"81c8e165-dea9-4d6e-9e5b-a6be51cef797"}}],"id":"c4d13d26-3617-437c-8ad1-a1e4cd2b673f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"names\": [\n \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes\",\n \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_502\"\n ]\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics:batchGet","description":"Timeseries data for a provided list of metric names for a source-destination pair.
\nIf you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example request, Batch Get Summary - Multi Destination Enabled, can be found in the Example requests dropdown. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","metrics:batchGet"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"9936797d-c3c2-43a9-af7a-9977cdabd499","name":"Batch Get Event Delivery Metrics","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics:batchGet"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metrics\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_502\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 17,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-23T00:00:00Z\"\n }\n ]\n}"},{"id":"3136ca75-e4ac-41b6-9064-4508653f027b","name":"Batch Get Event Delivery Metrics - Multi Destination Enabled","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics:batchGet"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metrics\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 172615,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 170609,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 170668,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 170422,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-23T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_502\",\n \"granularity\": \"DAY\",\n \"datapoints\": [\n {\n \"value\": 9,\n \"timestamp\": \"2019-01-20T00:00:00Z\"\n },\n {\n \"value\": 8,\n \"timestamp\": \"2019-01-21T00:00:00Z\"\n },\n {\n \"value\": 17,\n \"timestamp\": \"2019-01-22T00:00:00Z\"\n },\n {\n \"value\": 4,\n \"timestamp\": \"2019-01-23T00:00:00Z\"\n }\n ],\n \"start_time\": \"2019-01-20T00:00:00Z\",\n \"end_time\": \"2019-01-23T00:00:00Z\"\n }\n ]\n}"}],"_postman_id":"c4d13d26-3617-437c-8ad1-a1e4cd2b673f"},{"name":"Get Metric Summary","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","id":"a8ef7327-8858-4c98-9b30-9dc4d1301893"}}],"id":"85b484c5-73aa-47f7-83c7-9514ec60f19c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics:getSummary","description":"Summary of metrics for a source-destination pair.
\nIf you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example in Get Summary - Multi Destination Enabled in the Example requests. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","metrics:getSummary"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"230d30f6-a38b-4680-a472-b70cb1886df6","name":"Get Summary","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/metrics:getSummary"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes\",\n \"total\": 5331287,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes_on_first_attempt\",\n \"value\": 5211864\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/successes_after_retry\",\n \"value\": 119419\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/expired\",\n \"total\": 28455,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/discarded\",\n \"total\": 3,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/discarded_404\",\n \"value\": 3\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried\",\n \"total\": 792,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_502\",\n \"value\": 326\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_504\",\n \"value\": 405\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_ECONNABORTED\",\n \"value\": 55\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/retried_ECONNRESET\",\n \"value\": 6\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_success_average\",\n \"value\": 9.097975393\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_success_p95\",\n \"value\": 3.367597643\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_first_attempt_average\",\n \"value\": 4.163448849\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/metrics/time_to_first_attempt_p95\",\n \"value\": 3.3699638370000002\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n}"},{"id":"4f210997-eb43-4d99-933c-b9f5b9fdea05","name":"Get Summary - Multi Destination Enabled","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics:getSummary"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes\",\n \"total\": 5331287,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_on_first_attempt\",\n \"value\": 5211864\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_after_retry\",\n \"value\": 119419\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/expired\",\n \"total\": 28455,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/discarded\",\n \"total\": 3,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/discarded_404\",\n \"value\": 3\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried\",\n \"total\": 792,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_502\",\n \"value\": 326\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_504\",\n \"value\": 405\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_ECONNABORTED\",\n \"value\": 55\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried_ECONNRESET\",\n \"value\": 6\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success_average\",\n \"value\": 9.097975393\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success_p95\",\n \"value\": 3.367597643\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_average\",\n \"value\": 4.163448849\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_p95\",\n \"value\": 3.3699638370000002\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n}"}],"_postman_id":"85b484c5-73aa-47f7-83c7-9514ec60f19c"},{"name":"Batch Get Metric Summary","event":[{"listen":"test","script":{"exec":["// Segment Engineering","// Don't fail on validation error","pm.test(\"Status code is 200 or 400\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200,400]);","});",""],"type":"text/javascript","id":"c7cd096e-505c-4239-8e5a-b1fb93bede49"}}],"id":"079557c7-ca59-4fbf-9dc3-4ece0df67f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"names\": [\n \"workspaces/myworkspace/sources/js/destinations/google-analytics\"\n ]\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/event-delivery-metrics:batchGetSummary","description":"Summaries for a provided list of source-destination pairs.
\nIf you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example in Batch Get Metric Summary - Multi Destination Enabled in the Example requests. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","event-delivery-metrics:batchGetSummary"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"d307a4ae-61b8-4bab-8dc6-3dda2b81497d","name":"Batch Get Summary","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/event-delivery-metrics:batchGetSummary"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metric_summaries\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes\",\n \"total\": 5331287,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes_on_first_attempt\",\n \"value\": 5211864\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes_after_retry\",\n \"value\": 119419\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/expired\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/discarded\",\n \"total\": 5289153,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/discarded_UNSUPPORTED_EVENT_TYPE\",\n \"value\": 5289153\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/retried\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success_average\",\n \"value\": 0\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success_p95\",\n \"value\": 0\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt_average\",\n \"value\": 3.80065656\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt_p95\",\n \"value\": 3.379069625\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes\",\n \"total\": 2989,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes_on_first_attempt\",\n \"value\": 2920\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes_after_retry\",\n \"value\": 69\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/expired\",\n \"total\": 2955,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/discarded\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried\",\n \"total\": 35296,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried_ENOTFOUND\",\n \"value\": 35295\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried_ECONNABORTED\",\n \"value\": 1\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success_average\",\n \"value\": 9.293602542\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success_p95\",\n \"value\": 2.885951956\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt_average\",\n \"value\": 4.399057602\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt_p95\",\n \"value\": 2.913386417\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n }\n ]\n}"},{"id":"6cbdc2bf-de31-4d16-b386-0b4821733269","name":"Batch Get Summary - Multi Destination Enabled","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/event-delivery-metrics:batchGetSummary"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_delivery_metric_summaries\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes\",\n \"total\": 5331287,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_on_first_attempt\",\n \"value\": 5211864\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/successes_after_retry\",\n \"value\": 119419\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/expired\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/discarded\",\n \"total\": 5289153,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/discarded_UNSUPPORTED_EVENT_TYPE\",\n \"value\": 5289153\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/retried\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success_average\",\n \"value\": 0\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_success_p95\",\n \"value\": 0\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_average\",\n \"value\": 3.80065656\n },\n {\n \"name\": \"workspaces/myworkspace/sources/js/destinations/zendesk/config/1a2b3c5d6e7f8g9h0i1a2b3c5/metrics/time_to_first_attempt_p95\",\n \"value\": 3.379069625\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1\",\n \"metric_summary\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/successes\",\n \"total\": 2989,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/successes_on_first_attempt\",\n \"value\": 2920\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/successes_after_retry\",\n \"value\": 69\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/config/5c3b2a1i0h9g8f7e6d5c3b2a1/webhooks/metrics/expired\",\n \"total\": 2955,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/discarded\",\n \"total\": 0,\n \"metric_breakdown\": []\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/retried\",\n \"total\": 35296,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/retried_ENOTFOUND\",\n \"value\": 35295\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/retried_ECONNABORTED\",\n \"value\": 1\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/time_to_success\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/time_to_success_average\",\n \"value\": 9.293602542\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/config/5c3b2a1i0h9g8f7e6d5c3b2a1/metrics/time_to_success_p95\",\n \"value\": 2.885951956\n }\n ]\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metric/config/5c3b2a1i0h9g8f7e6d5c3b2a1s/time_to_first_attempt\",\n \"total\": 0,\n \"metric_breakdown\": [\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/config/5c3b2a1i0h9g8f7e6d5c3b2a1/time_to_first_attempt_average\",\n \"value\": 4.399057602\n },\n {\n \"name\": \"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/config/5c3b2a1i0h9g8f7e6d5c3b2a1/time_to_first_attempt_p95\",\n \"value\": 2.913386417\n }\n ]\n }\n ],\n \"start_time\": \"2018-12-26T00:00:00Z\",\n \"end_time\": \"2019-01-25T00:00:00Z\"\n }\n ]\n}"}],"_postman_id":"079557c7-ca59-4fbf-9dc3-4ece0df67f9b"}],"id":"4b5db186-3514-4ac8-a362-b8a582ab7cfb","description":"The Event Delivery Metrics APIs allow you to get delivery metrics for events sent to any destination configured in cloud mode.
\nTimeseries APIs allow you to get a breakdown of a specific metric name for a source-destination pair over a specified time range, broken out by a specific granularity. Based on the granularity, there are retrictions on the time range you can query:
\nMinute Granularity
Max time range: 4 hours
Oldest possible start time: 48 hours in the past
Hour Granularity
Max Time range: 1 week
Oldest possible start time: 10 days in the past
Day Granularity
Max time range: 60 days
Oldest possible start time: 60 days in the past
Defaults
The defaults for granularity, start time, and end time if not set are:
Granularity: minute
End Time: current time
Start Time:
Note that all timestamps are in UTC.
\nSummary APIs allow you to get the total of all metrics for source-destination pairs over a specific time range. 60 days is the oldest possible start day allowed.
\nThe following all possible metric names you can get from the Event Delivery APIs:
\nUnit: integer
\nsuccesses: total number of successfully delivered event to the destination.successes_on_first_attempt: total number of successfully delivered events on the first attempt.successes_after_retry: total number of successfully delivered events after more than one attempt. An event is retried because it was rejected from a destination with a specific error type. Events with these error types will be retried for up to 4 hours. See more info on Segment's destination retry policy here.Unit: integer
\ndiscarded: total number of events that were rejected by the destination and Segment will not retry.
discareded_<error_type>: total number of a specific discarded error type. With a few exceptions, these error types are generally set by the destinations' API. Examples are:
discarded_MESSAGE_REJECTEDdiscarded_400discarded_ENOTFOUNDretried: total number of events that were rejected by a destination and Segment will retry. Every time an event is rejected by a destination with a retryable error, it gets counted as 1 retried. This means that a single event can be counted multiple times for each attempt Segment makes trying to deliver it. For example, if we tried to send an event 7 times and then it was successful on the 8th attempt, the retried count will be 7 and successes will be 1.
retried_<error_type>: total number of a specific retried error type. These error types are set by the destinations' API. Examples are:
retried_500retried_429expired: total number of retried events that have reached their max retry attempts and will no longer be retried by Segment.
Unit: seconds
\ntime_to_first_attempt_average: average time it took to attempt to send events to the destination.time_to_first_attempt_p95: time it took to attempt to send 95% of your evnets to the destination.time_to_success_average: average time it took for events to be successful to the destination. This includes the time it took for retried events to be successful.time_to_success_p95: time it took for 95% of your events to be successful. This includes the time it took for retried events to be successful.Before attempting to send an event to a destination, Segment will do initial checks and reject events we know won't be successfully delivered to the destination. The following error types are set by Segment:
\nMESSAGE_REJECTED
This error type means the event payload is missing a required destination field such as user_id or email.
INVALID_SETTINGS
This error type means that required destination settings are missing or invalid.
UNSUPPORTED_EVENT_TYPE
This error type means the destination does not support the Segment event type.
The name of the metrics you can view in the Segment App are different than the name of the metrics returned from the API. However, the values are the same. Here is a breakdown of the name of the metrics in the App and their names returned from the Event Delivery APIs:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"71b86c06-8d76-4793-819b-9caab03f3d51"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7a95dfb5-c7d3-423f-aa4b-8c954333d1ed"}}],"_postman_id":"4b5db186-3514-4ac8-a362-b8a582ab7cfb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}}},{"name":"Destination Filters","item":[{"name":"Create Filter","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","var r = pm.response.json();","pm.environment.set(\"filter_name\", r.name);"],"type":"text/javascript","id":"a2f239a7-cbe0-4636-a418-85912becb915"}}],"id":"41c4fcef-afec-4b55-87bf-3cd984cecb1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"title\": \"Only allow track events\",\n\t\t\"if\": \"type != 'track'\",\n\t\t\"actions\": [\n\t\t\t{\n\t\t\t\t\"type\": \"drop_event\"\n\t\t\t}\t\n\t\t],\n\t\t\"enabled\": true\n\t}\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/","description":"Create a destination filter for a specific source and destination pair.
\nIf you have multi-instance destinations configured to the specific source you must supply a destination configuration id in the request parameters. An example request, Create Filter - Multi Destination Enabled, can be found in the Example requests dropdown. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","filters",""],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"d3b1097c-fdea-4839-b41a-1548cef7b4af","name":"Create Filter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"title\": \"Only allow track events\",\n\t\t\"if\": \"type != 'track'\",\n\t\t\"actions\": [\n\t\t\t{\n\t\t\t\t\"type\": \"drop_event\"\n\t\t\t}\t\n\t\t],\n\t\t\"enabled\": true\n\t}\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Apr 2019 16:25:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"302"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=LBrB8JF9xsJMtjbvMnk1ZqstIrB3NBczPwJmXXURfHyPLuVozXAlaI+YzDksQmDqKqLRYdySyL7Wdeixc1jGOvYzcp4oAxSphvMT40+yXDoOyTXRZI8/0jeQ/bJJ; Expires=Thu, 18 Apr 2019 16:25:40 GMT; Path=/"},{"key":"x-envoy-upstream-service-time","value":"144"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/developer-plan/sources/diggory-filters/destinations/google-analytics/filters/df_1JjE7f3gz8OXU6lVbUGuDhHcyKl\",\n \"if\": \"type != 'track'\",\n \"actions\": [\n {\n \"type\": \"drop_event\",\n \"fields\": {}\n }\n ],\n \"title\": \"Only allow track events\",\n \"description\": \"\",\n \"enabled\": true\n}"},{"id":"f11bf659-d729-4d3e-b859-c005153dd981","name":"Create Filter - Multi Destination Enabled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"title\": \"Only allow track events\",\n\t\t\"if\": \"type != 'track'\",\n\t\t\"actions\": [\n\t\t\t{\n\t\t\t\t\"type\": \"drop_event\"\n\t\t\t}\t\n\t\t],\n\t\t\"enabled\": true\n\t}\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/filters/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/developer-plan/sources/diggory-filters/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/filters/df_1JjE7f3gz8OXU6lVbUGuDhHcyKl\",\n \"if\": \"type != 'track'\",\n \"actions\": [\n {\n \"type\": \"drop_event\",\n \"fields\": {}\n }\n ],\n \"title\": \"Only allow track events\",\n \"description\": \"\",\n \"enabled\": true\n}"}],"_postman_id":"41c4fcef-afec-4b55-87bf-3cd984cecb1b"},{"name":"Get Filter","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Filter is created\", function () {"," var jsonData = pm.response.json();"," var destinationName = pm.environment.get(\"destination_name\");"," pm.expect(jsonData.name).to.include(destinationName);"," pm.expect(jsonData.if).to.not.be.empty;","});"],"type":"text/javascript","id":"fe303d95-b30e-4d19-82ef-7d3bc85da421"}}],"id":"6d1277fd-0d57-450f-9396-71b909b466ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123","description":"Get a destination filter by the destination filter id.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"f357b983-781d-4b72-bd96-9f3bf0fca54c","name":"Get Filter","originalRequest":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Apr 2019 16:26:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"302"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=msXRnDUuGyJv6WUljK0SlodNIBZuqTA/o/fVkWP/UZLkLRABWSsq0xDA2ovOq8+A12lCmE4Pmh2kMTx9ydyewovJYm5zZXZcNIet+/RxvC7dxsGN0rlZ5lDpax1x; Expires=Thu, 18 Apr 2019 16:26:16 GMT; Path=/"},{"key":"x-envoy-upstream-service-time","value":"67"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"workspaces/developer-plan/sources/diggory-filters/destinations/google-analytics/filters/df_1JjE7f3gz8OXU6lVbUGuDhHcyKl\",\n \"if\": \"type != 'track'\",\n \"actions\": [\n {\n \"type\": \"drop_event\",\n \"fields\": {}\n }\n ],\n \"title\": \"Only allow track events\",\n \"description\": \"\",\n \"enabled\": true\n}"}],"_postman_id":"6d1277fd-0d57-450f-9396-71b909b466ae"},{"name":"List Filters","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Filters are returned\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.filters).to.be.an('array').that.is.not.empty;","});"],"type":"text/javascript","id":"bfbb9db8-e785-4182-adcb-b0985eafbe44"}}],"id":"69bc13d5-e1f8-4e3f-bea6-102a4ba618c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters","description":"List destination filters for a specific source and destination pair.
\nIf you have multi-instance destinations configured to the specific source you must supply a destination configuration id in the request parameters. An example request, List Filters - Multi Destination Enabled, can be found in the Example requests dropdown. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as \"instances/$destinationConfigurationId/configuration\".
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics","filters"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"4b3b94ed-002a-4089-b0dc-e6d7ea5a1b59","name":"List Filters","originalRequest":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Apr 2019 16:26:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"960"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=hM4+/VFR3iCWFFYDOGOzyEsBJJaoiMBdf3/zXTvAJs+rVXQEtl/Tu0iUpBnxSUhiGmIYQg9PzRDZcyALmmDysbeixAvYd8xyEsyODeSQlxuJ0MHGMTPT6udYZQhP; Expires=Thu, 18 Apr 2019 16:26:40 GMT; Path=/"},{"key":"x-envoy-upstream-service-time","value":"87"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"filters\": [\n {\n \"name\": \"workspaces/developer-plan/sources/diggory-filters/destinations/google-analytics/filters/df_1JjE7f3gz8OXU6lVbUGuDhHcyKl\",\n \"if\": \"type != 'track'\",\n \"actions\": [\n {\n \"type\": \"drop_event\",\n \"fields\": {}\n }\n ],\n \"title\": \"Only allow track events\",\n \"description\": \"\",\n \"enabled\": true\n }\n ]\n}"},{"id":"2a6cbb55-1640-4178-9610-88720630cd9a","name":"List Filters - Multi Destination Enabled","originalRequest":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/filters"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"filters\": [\n {\n \"name\": \"workspaces/developer-plan/sources/diggory-filters/destinations/google-analytics/config/1a2b3c5d6e7f8g9h0i1a2b3c5/filters/df_1JjE7f3gz8OXU6lVbUGuDhHcyKl\",\n \"if\": \"type != 'track'\",\n \"actions\": [\n {\n \"type\": \"drop_event\",\n \"fields\": {}\n }\n ],\n \"title\": \"Only allow track events\",\n \"description\": \"\",\n \"enabled\": true\n }\n ]\n}"}],"_postman_id":"69bc13d5-e1f8-4e3f-bea6-102a4ba618c2"},{"name":"Update Filter","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Filter is updated\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.if).to.eql(\"type = 'identify' and !contains(traits.email, '@mycompany.com')\");"," pm.expect(jsonData.title).to.eql(\"Drop PII from identify events\");","});"],"type":"text/javascript","id":"58567407-efe6-438d-b912-d9802ecf1ff8"}}],"id":"d7529815-a789-4293-973c-ad78a4e0ca62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \t\"if\": \"type = 'identify' and !contains(traits.email, '@mycompany.com')\",\n \t\"actions\": [\n \t\t{\n \t\t\t\"type\": \"blacklist_fields\",\n \t\t\t\"fields\": {\n \t\t\t\t\"traits\": {\n \t\t\t\t\t\"fields\": [\"email\", \"name\"]\n \t\t\t\t}\n \t\t\t}\n \t\t}\n \t],\n \t\"title\": \"Drop PII from identify events\"\n },\n \"update_mask\": {\n \t\"paths\": [\"if\", \"actions\", \"title\"]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123","description":"Update a destination filter.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7529815-a789-4293-973c-ad78a4e0ca62"},{"name":"Delete Filter","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"aac731ec-571d-4295-91f9-12a613eb2224"}}],"id":"ef71e1c6-7ff7-4e08-a4d3-c18bdf3fbef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123","description":"Delete a destination filter.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js/destinations/google-analytics/filters/df_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef71e1c6-7ff7-4e08-a4d3-c18bdf3fbef5"},{"name":"Preview Filter","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Segment Engineering","// Defer calling \"Delete Destination\" until the end","postman.setNextRequest(\"Delete Destination\");"],"type":"text/javascript","id":"fab177d7-2d6f-4325-a2d4-ca6091ae89dd"}}],"id":"08e3dc19-93fc-4a83-942d-329e26a08e28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"if\": \"all\",\n\t\t\"actions\": [\n\t\t\t{\n\t\t\t\t\"type\": \"blacklist_fields\",\n\t\t\t\t\"fields\": {\n\t\t\t\t\t\"properties\": {\n\t\t\t\t\t\t\"fields\": [\"name\", \"age\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\t\n\t\t],\n\t\t\"enabled\": true\n\t},\n\t\"input\": \"{ \\\"userId\\\": \\\"6592\\\", \\\"properties\\\": { \\\"name\\\": \\\"Bob Smith\\\", \\\"age\\\": \\\"40\\\", \\\"order\\\": \\\"129\\\" } }\"\n}"},"url":"https://platform.segmentapis.com/v1beta/filters/preview","description":"This endpoint allows you to preview a Destination Filter against an arbitrary JSON payload without touching your production data. This is useful for testing.
\nRequest Body
\nResponse Body
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","filters","preview"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"61467a2e-135a-42f4-ba2c-5d602ca4beb0","name":"Preview Filter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"if\": \"all\",\n\t\t\"actions\": [\n\t\t\t{\n\t\t\t\t\"type\": \"blacklist_fields\",\n\t\t\t\t\"fields\": {\n\t\t\t\t\t\"properties\": {\n\t\t\t\t\t\t\"fields\": [\"name\", \"age\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\t\n\t\t],\n\t\t\"enabled\": true\n\t},\n\t\"input\": \"{ \\\"userId\\\": \\\"6592\\\", \\\"properties\\\": { \\\"name\\\": \\\"Bob Smith\\\", \\\"age\\\": \\\"40\\\", \\\"order\\\": \\\"129\\\" } }\"\n}"},"url":"https://platform.segmentapis.com/v1beta/filters/preview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Apr 2019 16:27:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=yfvCr/6jwU8ngW8wjoTzQVNVbvWCRjdzOrd/bt1eeuQ6sbwlNKNUu9PY90MVEXFn9bvvwaiUW26Kgu10EqvQiuD7dDfqcca6TzWRTmCaRzr+vcGvwCVkMcqq8lfh; Expires=Thu, 18 Apr 2019 16:27:13 GMT; Path=/"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"input\": \"{ \\\"userId\\\": \\\"6592\\\", \\\"properties\\\": { \\\"name\\\": \\\"Bob Smith\\\", \\\"age\\\": \\\"40\\\", \\\"order\\\": \\\"129\\\" } }\",\n \"output\": \"{\\\"properties\\\":{ \\\"order\\\": \\\"129\\\" },\\\"userId\\\":\\\"6592\\\"}\",\n \"diff\": \" {\\n \\t\\\"properties\\\": {\\n-\\t\\t\\\"age\\\": \\\"40\\\",\\n-\\t\\t\\\"name\\\": \\\"Bob Smith\\\",\\n \\t\\t\\\"order\\\": \\\"129\\\"\\n \\t},\\n \\t\\\"userId\\\": \\\"6592\\\"\\n }\"\n}"}],"_postman_id":"08e3dc19-93fc-4a83-942d-329e26a08e28"}],"id":"161989fb-595c-4cb5-9ef9-4cd8ca82e52f","description":"Note: The Destination Filters API is available only to Business customers. If\nyou would like to know more, please don't hesitate to reach out to us at\nfriends@segment.com.
\nThe Destination Filters API provides fine-grained controls that allow you to\nconditionally prevent data from being delivered to specific cloud-based\n(server-side) destinations. You can filter entire events (for example,\nselectively drop them) or whitelist / blacklist individual fields in events\nbefore they are sent. You can conditionally apply filters to each event based\non the contents of that event’s payload. For example, you could apply a filter\nonly to Track events with a \"plan\" property equal to \"Professional\" or you\ncould apply a filter only to events with a user email address that does not\nmatch \"*@mycompany.com\".
\nDestination Filters are a great for:
\nReducing the volume of events being delivered to a destination to save on\ncosts
\nFiltering out Personally Identifying Informaion (PII) from events being sent\nto a destination that shouldn't get PII
\nPreventing internal user activity from reaching an analytics tool
\nSending only the events that you care about to an custom webhook
\nDestination Filters are available on a beta basis to all Business customers,\nand are only supported for cloud-based (server-side) destinations. S3 and warehouse destinations are not yet supported.
\nThere are three filters that can be applied to events:
\nThe whitelist_fields and blacklist_fields filters may only filter fields\ninside the following top-level fields of Segment events:
propertiescontexttraitsFilters are applied in the following order for each event:
\ndrop_eventsample_eventwhitelist_fieldsblacklist_fieldsFilters can optionally be applied to an event by writing an \"if\" statement\nusing Filter Query Language (\"FQL\"), Segment’s simple query language for\nstreaming JSON. FQL statements evaluate to true or false based on the contents\nof each event, allowing you to only apply filters to specific events.
\nFor example, given the following event payload:
\n{\n \"event\": \"Button Clicked\",\n \"type\": \"track\",\n \"context\": {\n \"library\": {\n \"name\": \"analytics.js\",\n \"version\": \"1.0\",\n }\n }\n}\nThe following FQL statements will evaluate to \"true\", causing the filter to be\napplied:
\nevent = 'Button Clicked'event = 'Button Clicked' and type = 'track'match(context.library.version, '1.*')type = 'identify' or type = 'track'And the following FQL statements will evaluate to \"false\", causing the filter to be skipped:
\nevent = 'Screen Tapped'context.path.path = '/login'match (context.library.version, '2.*')For more detailed documentation including a list of all operators and functions,\nsee the FQL Documentation.
\nTo apply a filter to all events going to a destination, you can supply an \"if\"\nstatement of \"all\". All actions in that filter will be applied to events before\nbeing delivered to that destination.
\nDestination Filters currently have the following limits:
\nIf you would like any of these limits lifted, please reach out to us at\nfriends@segment.com.
\nThe drop_event action will cause the event to be dropped and not sent to the\ndestination if the \"if\" statement evaluates to true.
The sample_event action will allow only a percentage of events through. It can\nsample randomly or, if given a path attribute, it can sample a percentage of\nevents based on the contents of a field. This is useful for sampling all events\nfor a percentage of users rather than a percentage of all events for all\nusers.
The whitelist_fields action takes a list of nested objects (e.g. context,\nproperties.orderDetails) and a list of fields for each object that should be\nallowed, with all other fields in those objects dropped.
| Attribute | Type | Description | |\n| --------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------- | -------- |\n| type | string | The action name. For the whitelist fields action, this must be \"whitelist_fields\". | required |\n| fields | map of string → Field List | A map of nested JSON objects that should have their properties filtered. The map key is the path to the nested JSON object (e.g. context.ip, properties, etc.) and the value is a field list object (see below) that specifies which fields within the object to allow.
Nested JSON objects not specified in this map will be untouched by this filter. | required |
The blacklist_fields action takes a list of nested objects (e.g. context,\nproperties.orderDetails) and a list of fields for each object that should be\ndropped, with all other fields in those objects untouched.
The create regulation endpoint will be used to create new regulations on the particular workspace. You can set the regulation type and the attributes to regulate.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","regulations"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"276c3ef1-9639-4d1d-95f1-d7a44e9b091b","name":"Create Regulation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"regulation_type\": \"Suppress_With_Delete\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"foo-user\",\n \"bar-user\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Apr 2019 23:14:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"7"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"regulate_id\": \"REDACTED\"\n}"}],"_postman_id":"fc85b824-cced-4e99-ad4c-bc4457d7dba7"},{"name":"Get Regulation","id":"ee68cf23-ce52-4e9d-a078-678f3cb27fe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations/1KQVncbOPeRGjRcpuOHdnhDwPn7","description":"Get regulation fetches the information about a previously submitted regulation. You supply the regultion id you got back when you created the regulation request. You get back the status of the regulation, when it was created, when it was finished and the attributes being regulated.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","regulations","1KQVncbOPeRGjRcpuOHdnhDwPn7"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"1b8a0f6f-8835-427a-a5c5-21d998c1da3a","name":"Get Regulation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations/1KQVncbOPeRGjRcpuOHdnhDwPn7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Apr 2019 23:22:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1457"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"20"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"workspace_id\": \"REDACTED\",\n \"overall_status\": \"finished\",\n \"stream_status\": [\n {\n \"id\": \"REDACTED\",\n \"destination_status\": [\n {\n \"name\": \"Segment\",\n \"id\": \"segment\",\n \"status\": \"finished\",\n \"err_string\": \"\",\n \"finished_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n },\n {\n \"id\": \"REDACTED\",\n \"destination_status\": [\n {\n \"name\": \"Segment\",\n \"id\": \"segment\",\n \"status\": \"finished\",\n \"err_string\": \"\",\n \"finished_at\": \"0001-01-01T00:00:00Z\"\n }\n ]\n }\n ],\n \"created_at\": \"2019-04-27T00:12:56Z\",\n \"finished_at\": \"2019-04-28T22:50:07Z\"\n}"}],"_postman_id":"ee68cf23-ce52-4e9d-a078-678f3cb27fe5"},{"name":"Delete Regulation","id":"1c74a5fd-b1c4-4f66-a13a-fccb15207d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations/1KYs688u4F8nDaARd1nrFyN5LbJ","description":"Regulations that are still in the initialized state can be deleted using this endpoint
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","regulations","1KYs688u4F8nDaARd1nrFyN5LbJ"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"40c6001c-5dd6-490b-8f3d-629347fa9be1","name":"Delete Regulation","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations/1KYs688u4F8nDaARd1nrFyN5LbJ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Apr 2019 23:26:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"9"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"1c74a5fd-b1c4-4f66-a13a-fccb15207d7f"},{"name":"List Regulations","id":"33a152f1-7bdc-4940-b59f-afb2d9b515ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations","description":"This endpoint can list regulations present in the workspace and their status, times of creation and finishing.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","regulations"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"bb9cfcc6-9fc8-48e8-bb2c-b94a08d9236f","name":"List Regulations","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Apr 2019 23:28:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4391"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"87"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"initialized\",\n \"created_at\": \"2019-04-29T19:02:27Z\"\n },\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"initialized\",\n \"created_at\": \"2019-04-29T19:02:27Z\"\n }\n ],\n \"next_page_token\": \"REDACTED\"\n}"}],"_postman_id":"33a152f1-7bdc-4940-b59f-afb2d9b515ba"},{"name":"List Regulations based on status","id":"31f71aa6-bb67-4db8-8b0e-9624957ef50e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations?status=failed®ulation_types=Suppress_With_Delete®ulation_types=Suppress","description":"The list regulations endpoint also takes in a query parameter for status and regulation type using which you can narrow down the regulations which satisfy the query parameters
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","regulations"],"host":["https://platform.segmentapis.com"],"query":[{"description":{"content":"status filter can be set to failed, finished, running and initialized
regulations_types can be specified multiple times as a query parameter with all the regulation types you are interested in.
\n","type":"text/plain"},"key":"regulation_types","value":"Suppress_With_Delete"},{"key":"regulation_types","value":"Suppress"}],"variable":[]}},"response":[{"id":"3cbbf130-162b-4582-ac94-f69223109a95","name":"List Regulations based on status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":{"raw":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/regulations?status=failed®ulation_types=Suppress_With_Delete®ulation_types=Suppress","host":["https://platform.segmentapis.com"],"path":["v1beta","workspaces/myworkspace","regulations"],"query":[{"key":"status","value":"failed","description":"status filter can be set to `failed`, `finished`, `running` and `initialized`"},{"key":"regulation_types","value":"Suppress_With_Delete","description":"regulations_types can be specified multiple times as a query parameter with all the regulation types you are interested in."},{"key":"regulation_types","value":"Suppress"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Apr 2019 23:37:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5121"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"235"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"entries\": [\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"failed\",\n \"created_at\": \"2019-04-26T20:02:55Z\",\n \"finished_at\": \"2019-04-28T09:48:52Z\"\n },\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"failed\",\n \"created_at\": \"2019-04-26T18:18:46Z\",\n \"finished_at\": \"2019-04-28T07:58:51Z\"\n },\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"failed\",\n \"created_at\": \"2019-04-26T18:18:46Z\",\n \"finished_at\": \"2019-04-28T07:58:51Z\"\n },\n {\n \"regulate_id\": \"REDACTED\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"REDACTED\"\n ]\n },\n \"status\": \"failed\",\n \"created_at\": \"2019-04-26T18:18:46Z\",\n \"finished_at\": \"2019-04-28T07:58:51Z\"\n }\n ],\n \"next_page_token\": \"2019-04-25T23:54:08.149538Z\"\n}"}],"_postman_id":"31f71aa6-bb67-4db8-8b0e-9624957ef50e"},{"name":"Create Regulation on a source","id":"247117b5-3dc2-4965-b41c-6c1aacdf4762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"regulation_type\": \"Suppress_With_Delete\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"foo-user\",\n \"bar-user\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/regulations","description":"By using this endpoint you can create a regulation that is specific to a source.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js","regulations"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"99079f01-859a-4df1-a886-7cc6fe5ac1ea","name":"Create Regulaton on a source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"regulation_type\": \"Suppress_With_Delete\",\n \"attributes\": {\n \"name\": \"userId\",\n \"values\": [\n \"foo-user\",\n \"bar-user\"\n ]\n }\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/regulations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Apr 2019 18:51:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"78"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"regulate_id\": \"REDACTED\"\n}"}],"_postman_id":"247117b5-3dc2-4965-b41c-6c1aacdf4762"},{"name":"Delete Object from a Cloud Source","id":"01d75cc7-5256-44a7-af9b-62e255854f20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"regulation_type\": \"Suppress_With_Delete\",\n \"attributes\": {\n \"name\": \"objectId\",\n \"values\": [\n \"foo-user\",\n \"bar-user\"\n ]\n },\n \"collection\": \"app-collection\"\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/regulations","description":"This end point deletes an object from a specific cloud source.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace/sources/js","regulations"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"a537a369-b8ce-444f-a586-153911f5d82b","name":"Delete Object from a Cloud Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"regulation_type\": \"Suppress_With_Delete\",\n \"attributes\": {\n \"name\": \"objectId\",\n \"values\": [\n \"foo-user\",\n \"bar-user\"\n ]\n },\n \"collection\": \"app-collection\"\n}"},"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/sources/js/regulations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Apr 2019 18:57:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"44"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"regulate_id\": \"REDACTED\"\n}"}],"_postman_id":"01d75cc7-5256-44a7-af9b-62e255854f20"},{"name":"List suppressed users for a workspace","id":"39a1b03d-f265-465a-a0eb-2199dd114189","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/suppressed-users","description":"This endpoint lists the actively suppressed users for a workspace
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/myworkspace","suppressed-users"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"338f82f3-0cbd-48b9-b2fc-27ac116d5e47","name":"List suppressed users for a workspace","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://platform.segmentapis.com/v1beta/workspaces/myworkspace/suppressed-users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2019 14:48:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1408"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"108"},{"key":"server","value":"envoy"},{"key":"grpc-status","value":"0"},{"key":"grpc-message","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"attributes\": [\n {\n \"name\": \"userId\",\n \"values\": [\n \"Redacted\"\n ]\n },\n {\n \"name\": \"userId\",\n \"values\": [\n \"Redacted\"\n ]\n }\n ],\n \"next_page_token\": \"redacted\"\n}"}],"_postman_id":"39a1b03d-f265-465a-a0eb-2199dd114189"}],"id":"a81d2138-3aaf-4034-9452-fdaa74110f12","description":"In keeping with our commitment to support GDPR and future privacy regulations such as the CCPA, we offer the ability to delete and suppress data about end users if they are identified by a userId, should they revoke or alter their consent to data collection. For instance, if an end user in the EU invokes their Right to Object or Right to Erasure under the GDPR, you can use the following features in Segment to block ongoing data collection about the user, and additionally to delete all historical data across Segment’s systems, connected S3 buckets and warehouses, and supported downstream partners.
PLEASE NOTE (Business Plan Customers): If you utilize this functionality to delete data, this means that you will not be able to Replay that data. For standard Replay requests, we ask that you wait for deletions to complete and not submit any new deletion requests for the period of time that we replay data for you.
\nAll deletion and suppression actions within Segment are asynchronous, and fall under the umbrella of what we call “Regulations.” Regulations are requests to Segment to impart control over your data flow. They can be issued from your Segment Workspace Settings page under End User Privacy.
\n\nRegulations enable you to issue a single request to delete and suppress data about a user by userId. All regulations are by default scoped to your workspace and target all sources within the workspace. This way, you needn’t page over every source within Segment in order to delete data about a user across all your users.
You will be modifying/querying the regulations resource to submit new GDPR requests for deletion and suppression.
\nBefore interacting with the regulation endpoints, make sure you have generated access tokens for authentication. Actions which do not modify the state like listing regulations, getting the status of a regulation require read access to the workspace, where as creating new regulations, deleting existing ones require workspace owner permissions.
\nUser submitted requests will first be batched and then executed. The requests are guaranteed to be picked up and batched within a few days of submission while adhering to the workspace level limits on the concurrently running requests. The time to complete a request is dependent on the amount of data we have stored, and most requests finish within 7 days of submission.
\nEach regulate request can have at most 5,000 attribute values (either userId or objectId). \nIrrespective of the number of attribute values, each request can have a payload size of at most 4MB. Submitting requests with size greater than 4MB would result in an error. \nThere is no limit on the number of regulate requests that users can submit, although all submissions may not immediately be queued for processing. If you experience backlogs of more than 7 days, please reach out to us at friends@segment.com.
Segment’s Identity and Access Management (IAM) model is based on role-based access control, and has three central notions: subjects (mostly users), roles (a logical collection of actions), and policies (a link between a subject, role, and resource).
\nThe IAM API also allows you to manage invitations to your workspace. Invites can be created for a given email and a list of roles and resources. You can also list all pending invites and revoke / delete any pending invite.
\nTo see who has what permissions in a workspace, list the policies in that workspace. To grant a new permission, create a policy.
\nPreview is used to test function code before updating and deploying.
Example payload (Source Function)
\n![](\"https://segment.com/docs/guides/images/asset_N9oxVGCs.png\"){kind=link}
{\n \"payload\": {\n \"body\": {\"foo\":\"bar\"},\n \"headers\": {\n \"Accept\": [\"*/*\"],\n \"Content-Length\": [\"13\"],\n \"Content-Type\": [\"application/json\"],\n \"User-Agent\": [\"curl/7.64.1\"],\n \"X-Request-Id\": [\"64bcb940-8071-473c-8836-10d4f42b7a24\"]\n },\n \"queryParameters\": {}\n }\n}\nExample payload (Destination Function)
\n{\n \"type\": \"track\",\n \"event\": \"Test event\",\n \"userId\": \"foo@example.com\",\n \"timestamp\": \"2019-11-15T14:26:36-08:00\",\n \"properties\": {}\n\nExample response
\n{\n \"invoke\": {\n \"success\": true,\n \"output\": \"{\n \"events\": [{\n \"type\": \"track\",\n \"event\": \"Custom Source 1 Executed\",\n \"userId\": \"1234\"\n }],\n \"objects\": []\n }\",\n \"trace\": {\n \"source\": \"preview-1234\",\n \"version\": \"1234\",\n \"specversion\": \"1.0\",\n \"type\": \"com.segment.event.ack\",\n \"time\": \"2020-07-31T22:16:25.553Z\",\n \"trace\": {\n \"name\": \"invoke\",\n \"time\": \"2020-07-31T22:16:25.553Z\",\n \"duration\": \"0.201s\",\n \"logs\": [{\n \"time\": \"2020-07-31T22:16:25.653Z\",\n \"key\": \"NOTICE\",\n \"value\": \"{ foo: 'bar' }\"\n }]\n }\n }\n },\n \"logs\": [{\n \"message\": \"{ foo: 'bar' }\",\n \"created_at\": \"2020-07-31T22:16:25.656Z\"\n }],\n \"session_id\": \"1234\"\n}\nupdate_mask paths may contain: function.code, function.settings, functions.display_name, functions.logo_url, functions.description
Destination Function code updates will immediately be deployed to all destination instances.
\nSource Function code updates do not immediately get deployed to all source instances. You will need to call deploy on each source function instance for code changes to take effect. See the Sources API IsLatestVersion and Deploy endpoints.
Deleting a function cannot be undone. A function cannot be deleted if it is currently in use. Delete source function or destination function instances (using the Sources and Destinations APIs) before deleting the function.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c88336c1-101b-4ceb-b339-21f904810db4","id":"c88336c1-101b-4ceb-b339-21f904810db4","name":"Segment APIs","type":"collection"}},"urlObject":{"path":["v1beta","workspaces/workspace_id","functions/sfnc_123"],"host":["https://platform.segmentapis.com"],"query":[],"variable":[]}},"response":[{"id":"a62bce32-b6e5-40b8-96ad-ff8adf55e5c8","name":"Delete Function","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ...","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://platform.segmentapis.com/v1beta/workspaces/workspace_id/functions/sfnc_123"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"405390ac-8cfb-402d-a77b-41ac0960e23f"}],"id":"befc1625-5d48-4438-a4df-17d898e0edb0","description":"