Segment tools
The 11 Segment operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List sourcesGETLists the sources of the workspace with id, name, slug, enabled, metadata and labels. Returns the first 200, because the connection does not send pagination; pagination.totalEntries tells whether there are more.
- Get sourceGETReturns one source with its settings, write keys, metadata and labels.
- List connected destinationsGETLists the destinations that receive data from one source, with id, name, enabled and metadata. Returns the first 200, because the connection does not send pagination.
- List connected warehousesGETLists the warehouses that receive data from one source. Returns the first 200, because the connection does not send pagination.
- List destinationsGETLists the destinations of the workspace with id, name, enabled, metadata and the sourceId each one belongs to. Returns the first 200, because the connection does not send pagination; pagination.totalEntries tells whether there are more.
- Get destinationGETReturns one destination with its settings, metadata and the sourceId it belongs to.
- Get delivery metricsGETReturns the delivery metrics of one destination for the events of one source in a period, each metric with its total and breakdown. Without dates, it covers the last hour by minute.
- List warehousesGETLists the warehouses of the workspace with id, enabled, metadata and settings. Returns the first 200, because the connection does not send pagination; pagination.totalEntries tells whether there are more.
- Get warehouseGETReturns one warehouse with its settings and metadata.
- List warehouse syncsGETLists the latest syncs of one warehouse, with status and duration, to check whether the data is arriving. Returns the first 200, because the connection does not send pagination.
- Get events volumeGETReturns how many events the workspace received per bucket in a period, optionally grouped and filtered by source, event name and event type.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
