Skip to main content
GET
/
get-scores
Get scores
curl --request GET \
  --url https://api.trakkr.ai/get-scores \
  --header 'Authorization: Bearer <token>'
{
  "brand_id": "0000000000000x000000000000000000",
  "start_date": "2025-01-01",
  "end_date": "2025-01-03",
  "breakdown": [],
  "data": [
    {
      "date": "2025-01-01",
      "visibility": 85.5,
      "presence": 92.3
    },
    {
      "date": "2025-01-02",
      "visibility": 87.2,
      "presence": 91.8
    },
    {
      "date": "2025-01-03",
      "visibility": 86.9,
      "presence": 93.1
    }
  ],
  "errors": null
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Query Parameters

​
brand
string
required

The brand ID (32-character hexadecimal string)

Required string length: 32
​
breakdown
enum<string>[]

Array of breakdown types. Valid values:

  • [] or omitted - No breakdown, returns only time series data
  • ["model"] - Break down by AI model
  • ["prompt"] - Break down by prompt
  • ["model", "prompt"] - Break down by both
Maximum length: 2
​
start_date
string<date>

Start date in YYYY-MM-DD format. If not provided, defaults to 28 days before end_date. The total date range cannot exceed 90 days.

​
end_date
string<date>

End date in YYYY-MM-DD format. If not provided, defaults to the most recent report date for the brand. The total date range cannot exceed 90 days.

Response

Successful response

​
brand_id
string
required

The brand ID that was queried

Example:

"0000000000000x000000000000000000"

​
brand_name
string
required

The human-readable brand name

Example:

"Acme Corporation"

​
start_date
string<date>
required

The start date used for the query

Example:

"2025-01-01"

​
end_date
string<date>
required

The end date used for the query

Example:

"2025-01-31"

​
breakdown
enum<string>[]
required

The breakdown types that were requested

Example:
["model"]
​
data
object[]
required

Array of daily report data

​
errors
string[] | null

Array of non-critical error messages (null if no errors)

⌘I