Skip to main content
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": [
    "prompt_id",
    "model_id"
  ]
}'
{
  "data": [
    {
      "brand": {
        "id": "kw_915e742b-396d-4a86-ad57-8bc84e8c2232",
        "name": "Peec AI"
      },
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "visibility": 0.5,
      "sentiment": 50,
      "position": 1
    }
  ]
}

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

start_date
string<date>
required

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

Example:

"2025-09-22"

end_date
string<date>
required

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

Example:

"2025-09-22"

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 <= 1000
offset
number
default:0
Required range: x >= 0
dimensions
enum<string>[]

Dimensions to break down the report by.

Example:
["prompt_id", "model_id"]

Response

200 - application/json

Success

data
object[]
required