Segment APIs

Number of APIs: 62

Segment APIs enable you to collect customer data and send it to any destination you want.

The Config API is a set of REST APIs that enable you to programmatically manage Segment workspaces, sources, destinations and more.

This documents all the REST API methods, with example requests and responses. You can also load this into the Qodex API Development Environment to interact with the API with your own access tokens.

With the Config API you can:

  • List all your workspace sources and destinations to see how data flows through Segment
  • Create new sources to collect data from your website, mobile app or server
  • Create new destinations to send data to your analytics service or data warehouse
  • Enable and disable destinations to route data without code changes
  • Configure a tracking plan to see how data conforms to your expected schema

If there are other uses cases you'd like the API to support, get in touch.

  1. Sources - Get Schema Configuration GET {{host}}/{{version}}/{{source_name}}/schema-config

  2. Sources - Update Schema Configuration PATCH {{host}}/{{version}}/{{source_name}}/schema-config

  3. Integrations Catalog - List Catalog Destinations GET {{host}}/{{version}}/catalog/destinations?page_size=&page_token=

  4. Integrations Catalog - Get Catalog Source GET {{host}}/{{version}}/catalog/sources/javascript

  5. Integrations Catalog - Get Catalog Destination GET {{host}}/{{version}}/catalog/destinations/google-analytics

  6. Workspaces - Get Workspace GET {{host}}/{{version}}/{{workspace_name}}

  7. Sources - Create Source POST {{host}}/{{version}}/{{workspace_name}}/sources

  8. Sources - Get Source GET {{host}}/{{version}}/{{source_name}}

  9. Sources - Update Connected Warehouses PATCH {{host}}/{{version}}/{{source_name}}/connected-warehouses

  10. Tracking Plans - Create Tracking Plan POST {{host}}/v1beta/{{workspace_name}}/tracking-plans/