Skip to main content
POST
Use this endpoint to find campaign or journey IDs before querying analytics. Results include names and IDs from your workspace, including entities with no activity during a reporting period. Set SAGEPILOT_API_TOKEN to your API client token before running the cURL example, and use your regional base URL.

​
Required access

Use an API client v2 token with analytics.query and the dataset named in your request: marketing_attribution or outbound_messages. These grants allow campaign and journey lookup. They do not grant access to ticket member lists, ticket SQL, or journey flow definitions.

​
Body

​
string
default:"tickets"
Set marketing_attribution for revenue/ROAS reports or outbound_messages for delivery reports. If omitted, the endpoint defaults to tickets and requires that dataset’s access.
​
string
required
Use campaign_id or journey_id. Other dimensions are rejected for marketing/outbound datasets.
​
string
Optional case-insensitive name search. Omit to list names in alphabetical order.
​
integer
default:"20"
Maximum matches, from 1 to 50. There is no cursor; narrow your search if several entities have similar names.

​
Example request

Use a returned value in filters.journey_ids or filters.campaign_ids. No matches returns an empty members array. A missing scope or dataset grant returns 403; an unsupported dimension returns 400.