Answers

List Answers

post

Individual AI answers with their cited URLs and brand/competitor mentions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_kit_idintegerRequired

The Brand Kit ID

Body

brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago.

end_datestringOptional

End date (ISO 8601) on aeo_analyses.created_at. Defaults to today.

prompt_idintegerOptional

Filter answers by a single prompt (question) ID.

brand_mentionedbooleanOptional

When set, filter to answers where the brand was (or was not) mentioned.

pageintegerOptional

Page number

Default: 1

per_pageinteger · max: 100Optional

Items per page

Default: 25

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post/public_api/brand_kits/{brand_kit_id}/answers/list

POST /public_api/brand_kits/{brand_kit_id}/answers/list HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "brand_kit_id": 1,
  "start_date": "text",
  "end_date": "text",
  "prompt_id": 1,
  "providers": [
    "chat_gpt"
  ],
  "countries": [
    "AE"
  ],
  "brand_mentioned": true,
  "fields": [
    "id"
  ],
  "page": 1,
  "per_page": 25
}

{
  "data": [
    {
      "id": 1,
      "date": "text",
      "text": "text",
      "prompt": "text",
      "intent_stage": "awareness",
      "citations": [
        "text"
      ],
      "mentions": [
        "text"
      ],
      "persona": "text",
      "provider": "chat_gpt",
      "country": "AE",
      "brand_mentioned": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Get Answer

post

Individual AI answers with their cited URLs and brand/competitor mentions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_kit_idintegerRequired

The Brand Kit ID

Body

brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago.

end_datestringOptional

End date (ISO 8601) on aeo_analyses.created_at. Defaults to today.

prompt_idintegerOptional

Filter answers by a single prompt (question) ID.

brand_mentionedbooleanOptional

When set, filter to answers where the brand was (or was not) mentioned.

idintegerRequired

Resource ID

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post/public_api/brand_kits/{brand_kit_id}/answers/show

POST /public_api/brand_kits/{brand_kit_id}/answers/show HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "brand_kit_id": 1,
  "start_date": "text",
  "end_date": "text",
  "prompt_id": 1,
  "providers": [
    "chat_gpt"
  ],
  "countries": [
    "AE"
  ],
  "brand_mentioned": true,
  "id": 1,
  "fields": [
    "id"
  ]
}

{
  "data": {
    "id": 1,
    "date": "text",
    "text": "text",
    "prompt": "text",
    "intent_stage": "awareness",
    "citations": [
      "text"
    ],
    "mentions": [
      "text"
    ],
    "persona": "text",
    "provider": "chat_gpt",
    "country": "AE",
    "brand_mentioned": true
  }
}