GET /v1/brands/{brand_id}/prompts/answers/brands

Brands the answers name

The brands every answer under the filters names, each counted once per answer: the brand under its own name and its aliases in exactly the answers whose brand_appears is true, a registered competitor under its canonical name and relation with its aliases, a removed competitor left out. Every business the answers name counts, publishers and AI platforms included. Most answers first, then the better mean first place, then the name.

Takes the Visibility filters, composed with AND: report_id (repeat for several), scheduled_report_id, platform (repeat for several engines), date_from, date_to and category (repeat for several). Without date_from or date_to it reads the last 90 days (from 00:00 UTC 90 days ago), unless report_id names the reports or scope=default reads what the app opens on; pass an earlier date_from for a longer period. Offset paginated via limit (1-100, default 10) and offset.

Path parameters

Query parameters

  • limit integer optional

    Brands per page (1-100, default 10).

    default: 10

  • offset integer optional

    Brands to skip from the start.

    default: 0

  • report_id string optional

    Only these reports (UUIDs); repeat the parameter for several.

  • report_scope string optional

    all for every completed report of the brand, in place of naming each one (a report_id is then dropped); the other filters still apply, and without date_from or date_to the read covers the last 90 days.

  • scheduled_report_id string optional

    Only the runs of this Scheduled Report (UUID).

  • tracker_id string optional

    Only the runs of these trackers (a report's tracker_id; a scheduled report's id is its tracker's); repeat the parameter for several.

  • market_id string optional

    Only the runs in these markets (a report's market_id, a region config's id); repeat the parameter for several.

  • place string optional

    Only the runs in these places, as country|city lowercased (united states|austin, or united states| for the whole country; country|city|region for a town keyed apart from its namesake, australia|emerald|victoria), across every tracker; repeat the parameter for several.

  • scope string optional

    default reads what the app opens on (every scheduled report's runs plus the newest one-off reports) and takes no other report, tracker, market or place filter; all reads every completed report of the brand (a report_id is then dropped), over the last 90 days without date_from or date_to.

  • platform string optional

    Only answers from these engines; repeat the parameter for several.

  • date_from string optional

    Only answers from this moment on (ISO-8601). Without it or date_to, the last 90 days, unless report_id or scope=default bounds the read.

  • date_to string optional

    Only answers before this moment, exclusive (ISO-8601); not before date_from.

  • category string optional

    Only answers to prompts of these categories; repeat the parameter for several.

  • dry_run boolean optional

    Preview the call without executing it. Runs auth, scope, eligibility and body validation, then returns 200 with a dry_run object reporting the request-unit and credit cost plus a non-consuming quota snapshot. Nothing is debited, reserved, dispatched or mutated. An invalid body still returns 422.

    default: false

Responses

Brands the answers name application/json
Type: PromptAnswerBrandCountList
  • data array of PromptAnswerBrandCount required
  • has_more boolean required

    True when more items exist past this page. Fetch them with a larger offset.

  • limit integer required

    Page size that was applied.

    min: 1

  • offset integer required

    Number of items skipped before this page.

    min: 0

  • total integer required

    Total number of items matching the query, across all pages.

    min: 0

  • object string

    default: `list`

Example response
{
  "data": [
    {
      "answers": 214,
      "category": "direct_competitor",
      "name": "Nike",
      "object": "prompt_answer_brand_count",
      "position": 1.8
    }
  ],
  "has_more": false,
  "limit": 10,
  "object": "list",
  "offset": 0,
  "total": 1
}
Request validation failed application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Missing or invalid credentials application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid credentials"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
You do not have permission to access this resource application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "forbidden",
    "message": "You do not have permission to access this resource"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Resource not found application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Resource conflict application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "conflict",
    "message": "Resource conflict"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Per-minute rate limit exceeded application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Per-minute rate limit exceeded"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
An unexpected error occurred application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}
Service temporarily unavailable, please retry application/json
Type: ApiError
  • error object required
    Show fields
    • code string required

      Stable machine-readable error code from the catalog.

    • message string required

      Human-readable description suitable for logging.

    • details object

      Optional, code-specific context (e.g. errors array for validation_error, retry_after for service_unavailable). Shape depends on error.code; treat as opaque otherwise.

      Show fields

      Empty object (no properties).

  • Server-generated correlation id for the request. Mirrors the X-Correlation-ID response header. Include this when contacting support.

    format: `uuid`

Example response
{
  "error": {
    "code": "service_unavailable",
    "message": "Service temporarily unavailable, please retry"
  },
  "request_id": "9f6c4e8a-1d3b-4c8b-9f1e-7a3b1c2d3e4f"
}