Get Brands Report

curl --request POST \
  --url https://api.peec.ai/customer/v1/reports/brands \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "limit": 1000,
  "offset": 0,
  "start_date": "2025-09-22",
  "end_date": "2025-09-22",
  "dimensions": [
    "tag_id",
    "model_id"
  ],
  "filters": [
    {
      "field": "model_id",
      "operator": "in",
      "values": [
        "gpt-4o-search"
      ]
    }
  ],
  "having": [
    {
      "field": "brand_id",
      "operator": "in",
      "values": [
        "kw_abc123"
      ]
    }
  ],
  "order_by": [
    {
      "field": "visibility",
      "direction": "desc"
    }
  ]
}
'

{
  "data": [
    {
      "brand": {
        "id": "kw_915e742b-396d-4a86-ad57-8bc84e8c2232",
        "name": "Peec AI"
      },
      "mention_count": 42,
      "visibility": 0.5,
      "visibility_count": 5,
      "visibility_total": 10,
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "model_channel": {
        "id": "openai-1"
      },
      "tag": {
        "id": "tg_23abec5b-100a-4261-9ee7-1effe68f0149"
      },
      "topic": {
        "id": "to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6"
      },
      "country_code": "US",
      "chat": {
        "id": "ch_abc123"
      },
      "date": "2025-03-15",
      "week": "2025-03-10",
      "month": "2025-03-01",
      "share_of_voice": 0.15,
      "sentiment": 50,
      "sentiment_sum": 0,
      "sentiment_count": 10,
      "position": 1.5,
      "position_sum": 15,
      "position_count": 10
    }
  ]
}

Reports

Get Brands Report

Get a report on Brands.

Aggregation Formulas

When aggregating results across multiple rows/dimensions, use the following formulas:

sentiment: ((sum(sentiment_sum) / sum(sentiment_count)) / 2 + 0.5) * 100
position: sum(position_sum) / sum(position_count)
visibility: sum(visibility_count) / sum(visibility_total)
share_of_voice: mention_count / sum(mention_count)

`filters` vs `having`

filters are pre-aggregation row filters (applied as WHERE before GROUP BY). They shrink both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Note that brand_id in filters shrinks share_of_voice’s denominator too — so filtering to one brand collapses SoV to 1.0. Use having for brand_id if you want SoV preserved.

having are post-aggregation row filters (applied as HAVING after GROUP BY). They select which aggregated rows are returned and do not shrink ratio-metric denominators. Filtering {field: "brand_id", values: [X]} here returns only brand X’s row, but share_of_voice still divides X’s mentions by mentions across all in-scope brands — so SoV stays in [0, 1]. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id.

Population fields (model_id etc.) are also allowed in having but require the matching value in dimensions so the column appears in GROUP BY; otherwise the request is rejected.

When dimensions are requested, the share_of_voice denominator follows the same grouping as the numerator. Requesting prompt_id as a dimension produces per-(brand × prompt) rows whose share_of_voice is the brand’s mentions in that prompt divided by all brands’ mentions in that prompt.

POST

reports

brands

Get Brands Report

curl --request POST \
  --url https://api.peec.ai/customer/v1/reports/brands \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "limit": 1000,
  "offset": 0,
  "start_date": "2025-09-22",
  "end_date": "2025-09-22",
  "dimensions": [
    "tag_id",
    "model_id"
  ],
  "filters": [
    {
      "field": "model_id",
      "operator": "in",
      "values": [
        "gpt-4o-search"
      ]
    }
  ],
  "having": [
    {
      "field": "brand_id",
      "operator": "in",
      "values": [
        "kw_abc123"
      ]
    }
  ],
  "order_by": [
    {
      "field": "visibility",
      "direction": "desc"
    }
  ]
}
'

{
  "data": [
    {
      "brand": {
        "id": "kw_915e742b-396d-4a86-ad57-8bc84e8c2232",
        "name": "Peec AI"
      },
      "mention_count": 42,
      "visibility": 0.5,
      "visibility_count": 5,
      "visibility_total": 10,
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "model_channel": {
        "id": "openai-1"
      },
      "tag": {
        "id": "tg_23abec5b-100a-4261-9ee7-1effe68f0149"
      },
      "topic": {
        "id": "to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6"
      },
      "country_code": "US",
      "chat": {
        "id": "ch_abc123"
      },
      "date": "2025-03-15",
      "week": "2025-03-10",
      "month": "2025-03-01",
      "share_of_voice": 0.15,
      "sentiment": 50,
      "sentiment_sum": 0,
      "sentiment_count": 10,
      "position": 1.5,
      "position_sum": 15,
      "position_count": 10
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Query Parameters

project_id

string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

Body

project_id

string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

limit

number

default:1000

Required range: 1 <= x <= 10000

offset

number

default:0

Required range: x >= 0

start_date

string<date>

default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Example:

"2025-09-22"

end_date

string<date>

default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Example:

"2025-09-22"

dimensions

enum<string>[]

Dimensions to break down the report by.

Available options:

prompt_id,

model_id,

model_channel_id,

tag_id,

topic_id,

date,

week,

month,

country_code,

chat_id

Example:

["tag_id", "model_id"]

filters

object[]

Pre-aggregation row filters (applied as WHERE before grouping). Shrinks both the numerator and the denominator of ratio metrics. Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id. Filtering by brand_id here also shrinks share_of_voice's denominator — so SoV collapses to 1.0 when scoping to a single brand. If you want SoV preserved (X's share against all in-scope brands), put brand_id in having instead. Multiple filters are AND'd.

Deprecated: use model_channel_id filter instead

Show child attributes

Example:

[
  {
    "field": "model_id",
    "operator": "in",
    "values": ["gpt-4o-search"]
  }
]

having

object[]

Post-aggregation row filters (applied as HAVING after grouping). Allowed fields: model_id (deprecated), model_channel_id, country_code, prompt_id, tag_id, topic_id, chat_id, brand_id — population fields require the matching value in dimensions so the column appears in GROUP BY. Selects which aggregated rows are returned without shrinking ratio-metric denominators. Multiple filters are AND'd together.

Deprecated: use model_channel_id filter instead

Show child attributes

Example:

[
  {
    "field": "brand_id",
    "operator": "in",
    "values": ["kw_abc123"]
  }
]

order_by

object[]

Sort results by one or more fields. Multiple entries create a multi-key sort. Direction defaults to desc. When omitted, a default ordering is applied.

Show child attributes

Example:

[
  {
    "field": "visibility",
    "direction": "desc"
  }
]

Response

200 - application/json

Success

data

object[]

required

Show child attributes

Changelog Get Domains Report

⌘I