List the sources

GET

projects

{projectId}

sources

curl

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

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/sources",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

{
  "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": 0,
    "answers": 0,
    "subtitle": "0 prompts in your segments · 0 answers in 30 days · branded prompts reported separately",
    "customPromptsExcluded": true
  },
  "retrieval_share": {
    "value": null,
    "unit": "percent",
    "band": null,
    "n": 0,
    "delta": null,
    "within_noise": true,
    "low_sample": true,
    "state": "no_data",
    "note": "needs one full run"
  },
  "groups": [
    {
      "group": "actionable",
      "actionable": true,
      "types": [],
      "rows": []
    },
    {
      "group": "competitor_owned",
      "actionable": false,
      "types": [],
      "rows": []
    },
    {
      "group": "yours",
      "actionable": true,
      "types": [],
      "rows": []
    }
  ],
  "own_domain": {
    "domain": null,
    "retrieved": 0,
    "cited": 0,
    "pages": []
  }
}

{
  "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 figures cover: the window, its dates, the engines, the segments and the answers counted.

Show child attributes

A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move.

Show child attributes

groups

object[]

required

Show child attributes

own_domain

object

required

Show child attributes

⌘I

curl

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

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/sources",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

{
  "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": 0,
    "answers": 0,
    "subtitle": "0 prompts in your segments · 0 answers in 30 days · branded prompts reported separately",
    "customPromptsExcluded": true
  },
  "retrieval_share": {
    "value": null,
    "unit": "percent",
    "band": null,
    "n": 0,
    "delta": null,
    "within_noise": true,
    "low_sample": true,
    "state": "no_data",
    "note": "needs one full run"
  },
  "groups": [
    {
      "group": "actionable",
      "actionable": true,
      "types": [],
      "rows": []
    },
    {
      "group": "competitor_owned",
      "actionable": false,
      "types": [],
      "rows": []
    },
    {
      "group": "yours",
      "actionable": true,
      "types": [],
      "rows": []
    }
  ],
  "own_domain": {
    "domain": null,
    "retrieved": 0,
    "cited": 0,
    "pages": []
  }
}

{
  "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

List the sources

Authorizations

Path Parameters

Query Parameters

Response