Metrics

Get metrics per prompt

Markdown
GET
/v1/brands/{brandId}/metrics/prompts

Visibility, position, sentiment and the most-named competitors for each prompt, lowest visibility first. Use it to find the prompts where competitors win.

Authorization

bearer
AuthorizationBearer <token>

An API key from Settings → API keys in the Gensiv app.

In: header

Path Parameters

brandId*string

A brand id from GET /v1/brands.

Formatuuid

Query Parameters

from?string

First day to include, in UTC (YYYY-MM-DD). Defaults to 29 days before to.

to?string

Last day to include, in UTC (YYYY-MM-DD). Defaults to today.

engine?string

Only include responses from this engine. Use a slug from GET /v1/engines.

promptId?string

Only include responses to this prompt.

Formatuuid
topicId?string

Only include responses to prompts in this topic. Use an id from GET /v1/brands/{brandId}/prompt-groups.

Formatuuid
tagId?string

Only include responses to prompts with this tag. Use an id from GET /v1/brands/{brandId}/prompt-groups.

Formatuuid
branded?string

branded keeps only prompts that name the brand, non-branded leaves them out.

Value in

  • "branded"
  • "non-branded"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics/prompts"
{  "from": "2026-09-01",  "to": "2026-09-30",  "data": [    {      "promptId": "b5415d63-4390-40ec-8c2b-33a2db2f5c67",      "prompt": "What is the best CRM for a small agency?",      "responses": 14,      "visibility": 21.4,      "visibilityChange": -7.1,      "avgPosition": 3,      "sentiment": 50,      "topCompetitors": [        {          "competitorId": null,          "name": "Globex",          "mentions": 9        }      ]    }  ]}