Get the league table

GET

projects

{projectId}

league

curl

curl "https://api.citino.ai/v1/projects/{projectId}/league" \
  -H "Authorization: Bearer $CITINO_API_KEY"

{
  "project_id": "00000000-0000-4000-8000-000000000001",
  "scope": {
    "window": "30d",
    "from": "2026-10-09",
    "to": "2026-11-07",
    "engines": [
      "chatgpt",
      "google-ai-overview",
      "perplexity"
    ],
    "segmentScope": "claimed",
    "segments": [
      "wms"
    ],
    "promptScope": "category",
    "promptsInScope": 1,
    "answers": 30,
    "subtitle": "1 prompt in your segments · 30 answers in 30 days · branded prompts reported separately",
    "customPromptsExcluded": true
  },
  "rows": [
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000002",
        "name": "Acme",
        "own": true,
        "tracked": false
      },
      "rank": 1,
      "named_in": 18,
      "visibility": {
        "value": 60,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "share_of_voice": {
        "value": 66.7,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 18,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "sentiment": {
        "value": 70,
        "unit": "score",
        "band": null,
        "n": 18,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    },
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000003",
        "name": "Globex",
        "own": false,
        "tracked": false
      },
      "rank": 2,
      "named_in": 9,
      "visibility": {
        "value": 30,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "share_of_voice": {
        "value": 33.3,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "sentiment": {
        "value": 70,
        "unit": "score",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Authorizations

Authorization

string

header

required

An API key from Workspace settings → API keys, sent as Authorization: Bearer <key>.

Path Parameters

projectId

string

required

Query Parameters

window

enum<string>

A named window ending today in the project's market, or custom with from and to. Default 30d.

Available options:

7d,

30d,

90d,

180d,

365d,

custom

from

string

First day, inclusive. Required with window=custom.

Pattern: ^\d{4}-\d{2}-\d{2}$

string

Last day, inclusive. Required with window=custom.

Pattern: ^\d{4}-\d{2}-\d{2}$

segments

string

One value: your-segments (the default, the segments you claimed), all-segments, or one segment id.

Required string length: 1 - 120

engines

string

Comma-separated engine keys, narrowing the project's own engines.

Required string length: 1 - 200

Response

project_id

string<uuid>

required

The project asked about.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

scope

object

required

What the numbers cover: the window and its dates, the engines, the segments, the prompts and answers counted, and a sentence saying so. Shown beside every figure.

Show child attributes

rows

object[]

required

Show child attributes

⌘I

curl

curl "https://api.citino.ai/v1/projects/{projectId}/league" \
  -H "Authorization: Bearer $CITINO_API_KEY"

{
  "project_id": "00000000-0000-4000-8000-000000000001",
  "scope": {
    "window": "30d",
    "from": "2026-10-09",
    "to": "2026-11-07",
    "engines": [
      "chatgpt",
      "google-ai-overview",
      "perplexity"
    ],
    "segmentScope": "claimed",
    "segments": [
      "wms"
    ],
    "promptScope": "category",
    "promptsInScope": 1,
    "answers": 30,
    "subtitle": "1 prompt in your segments · 30 answers in 30 days · branded prompts reported separately",
    "customPromptsExcluded": true
  },
  "rows": [
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000002",
        "name": "Acme",
        "own": true,
        "tracked": false
      },
      "rank": 1,
      "named_in": 18,
      "visibility": {
        "value": 60,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "share_of_voice": {
        "value": 66.7,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 18,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "sentiment": {
        "value": 70,
        "unit": "score",
        "band": null,
        "n": 18,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    },
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000003",
        "name": "Globex",
        "own": false,
        "tracked": false
      },
      "rank": 2,
      "named_in": 9,
      "visibility": {
        "value": 30,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "share_of_voice": {
        "value": 33.3,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      },
      "sentiment": {
        "value": 70,
        "unit": "score",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Overview

Reference

Get the league table

Authorizations

Path Parameters

Query Parameters

Response