Measurement

The prompts you track and how often AI answers mention you, cite you and recommend you, with the count of answers behind every rate.

GET /brands/{brandId}/prompts

List the prompts tracked for a brand.

About this route	Detail
Returns	prompts: one row per prompt with its id, text, intent, branded, active, source and topic.
Seat	Any seat's key, a viewer's included.
Plan	Every plan.
Rate limit	None on this route.
Engine budget	Nothing this route does is metered.

Parameter	Type	What it is
brandId (path, required)	uuid	A brand id from GET /brands.

curl "https://api.ansengine.co/brands/{brandId}/prompts" \
  -H "Authorization: Bearer ak_your_key"

Status	When
200	prompts: one row per prompt with its id, text, intent, branded, active, source and topic.
401	No valid API key was sent.
404	No such brand for this key. A brand in another workspace and a client outside this seat's view answer the same way, so a 404 never confirms that an id exists.

Mentioned, cited and recommended rates per tracked prompt.

Note

Read over every measured day and every tracked prompt, on the apps people use. Developer API surfaces are left out of these rates.

About this route	Detail
Returns	prompts: per prompt id, the mentioned, cited and supported (recommended) rates as fractions of one, runs (the answers read) and a split by engine; window: what the rates were read over. Only measured prompts appear.
Seat	Any seat's key, a viewer's included.
Plan	Every plan.
Rate limit	None on this route.
Engine budget	Nothing this route does is metered.

Parameter	Type	What it is
brandId (path, required)	uuid	A brand id from GET /brands.

curl "https://api.ansengine.co/brands/{brandId}/prompt-performance" \
  -H "Authorization: Bearer ak_your_key"

Status	When
200	prompts: per prompt id, the mentioned, cited and supported (recommended) rates as fractions of one, runs (the answers read) and a split by engine; window: what the rates were read over. Only measured prompts appear.
400	An id in the path is not a valid id.
401	No valid API key was sent.
404	No such brand for this key. A brand in another workspace and a client outside this seat's view answer the same way, so a 404 never confirms that an id exists.

Daily mentioned, cited and recommended rates over time.

About this route	Detail
Returns	points: one per measured day, with runs (the answers read), the mentioned, cited and supported rates as fractions of one, and the likely range of the mention rate; excluded: the developer API surfaces kept out of the line, with their runs; pause: why measurement stopped, when it has. A day with nothing measured has no point, never a zero.
Seat	Any seat's key, a viewer's included.
Plan	Every plan.
Rate limit	None on this route.
Engine budget	Nothing this route does is metered.

Parameter	Type	What it is
brandId (path, required)	uuid	A brand id from GET /brands.
days (query)	integer, 1 to 366	How many days back to read. The default is 90 and the most is 366.
branded (query)	one of 1	1 reads the prompts that mention the brand. Without it, the prompts that do not.
questions (query)	one of 1	1 adds each day's answers per prompt, so a reader that pools several days can range the pool by prompt.

curl "https://api.ansengine.co/brands/{brandId}/visibility-trend" \
  -H "Authorization: Bearer ak_your_key"

Status	When
200	points: one per measured day, with runs (the answers read), the mentioned, cited and supported rates as fractions of one, and the likely range of the mention rate; excluded: the developer API surfaces kept out of the line, with their runs; pause: why measurement stopped, when it has. A day with nothing measured has no point, never a zero.
400	An id in the path is not a valid id.
401	No valid API key was sent.
404	No such brand for this key. A brand in another workspace and a client outside this seat's view answer the same way, so a 404 never confirms that an id exists.

Download every measured run as a CSV file.

About this route	Detail
Returns	A CSV file, one row per measured run. The default window is the last 90 days, and one file holds at most the newest 50,000 rows; a capped file says so in its name and in the X-Export-Truncated: 1 header.
Seat	Any seat's key, a viewer's included.
Plan	Every plan.
Rate limit	None on this route.
Engine budget	Nothing this route does is metered.

Parameter	Type	What it is
brandId (path, required)	uuid	A brand id from GET /brands.
sinceDays (query)	integer, 1 to 3650	How many days back to read. Any other value is ignored and the default applies.

curl "https://api.ansengine.co/brands/{brandId}/export/runs.csv" \
  -H "Authorization: Bearer ak_your_key"

Status	When
200	A CSV file, one row per measured run. The default window is the last 90 days, and one file holds at most the newest 50,000 rows; a capped file says so in its name and in the X-Export-Truncated: 1 header.
400	An id in the path is not a valid id.
401	No valid API key was sent.
404	No such brand for this key. A brand in another workspace and a client outside this seat's view answer the same way, so a 404 never confirms that an id exists.

Download the captured answers, verbatim, as JSON.

About this route	Detail
Returns	A JSON file of the captured answers with their sources, over the same window and under the same cap as the CSV.
Seat	Any seat's key, a viewer's included.
Plan	Every plan.
Rate limit	None on this route.
Engine budget	Nothing this route does is metered.

Parameter	Type	What it is
brandId (path, required)	uuid	A brand id from GET /brands.
sinceDays (query)	integer, 1 to 3650	How many days back to read. Any other value is ignored and the default applies.

curl "https://api.ansengine.co/brands/{brandId}/export/answers.json" \
  -H "Authorization: Bearer ak_your_key"

Status	When
200	A JSON file of the captured answers with their sources, over the same window and under the same cap as the CSV.
400	An id in the path is not a valid id.
401	No valid API key was sent.
404	No such brand for this key. A brand in another workspace and a client outside this seat's view answer the same way, so a 404 never confirms that an id exists.