Responses

List AI responses

Markdown
GET
/v1/brands/{brandId}/responses

Individual AI answers to your prompts, newest first: whether your brand was mentioned, its position, the competitors named and the sources cited.

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"
brandMentioned?string

true returns only responses that mention your brand, false only responses that do not.

Value in

  • "true"
  • "false"
competitorId?string

Only include responses that mention this tracked competitor.

Formatuuid
limit?number

Maximum number of responses to return.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor value from the previous page.

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/responses"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "promptId": "b5415d63-4390-40ec-8c2b-33a2db2f5c67",      "prompt": "What is the best CRM for a small agency?",      "engine": "perplexity",      "createdAt": "2019-08-24T14:15:22Z",      "brandMentioned": true,      "brandPosition": 2,      "brandSentiment": "positive",      "competitors": [        {          "competitorId": "be7195ac-4482-4082-b43f-9e70c41e9fc4",          "name": "Globex",          "position": 1,          "sentiment": "neutral"        }      ],      "citations": [        {          "url": "https://www.g2.com/categories/crm",          "domain": "g2.com",          "title": "Best CRM Software",          "position": 1        }      ]    }  ],  "nextCursor": "string"}