Get one prompt

GET

projects

{projectId}

prompts

{promptId}

curl

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

import os
import requests

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

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/prompts/{promptId}", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await 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": 1,
    "answers": 30,
    "subtitle": "30 answers in the last 30 days",
    "customPromptsExcluded": true
  },
  "prompt": {
    "id": "p_acme_001",
    "text": "best 3PL software for a growing ecommerce brand",
    "intent": "compare",
    "scope": "category",
    "segments": [
      "wms"
    ],
    "facets": [],
    "status": "active",
    "first_run_date": "2026-11-04",
    "answers": 30,
    "visibility": {
      "value": 60,
      "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"
    }
  },
  "series": {
    "start": "2026-10-09",
    "interval": "day",
    "unit": "percent",
    "series": [
      {
        "label": "Initech",
        "brand_id": "00000000-0000-4000-8000-000000000002",
        "own": true,
        "values": [
          null,
          null,
          null
        ]
      },
      {
        "label": "Globex",
        "brand_id": "00000000-0000-4000-8000-000000000003",
        "own": false,
        "values": [
          null,
          null,
          null
        ]
      }
    ],
    "markers": []
  },
  "by_engine": [
    {
      "engine": "chatgpt",
      "visibility": {
        "value": 60,
        "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"
      }
    },
    {
      "engine": "google-ai-overview",
      "visibility": {
        "value": null,
        "unit": "percent",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      },
      "position": {
        "value": null,
        "unit": "rank",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      }
    },
    {
      "engine": "perplexity",
      "visibility": {
        "value": null,
        "unit": "percent",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      },
      "position": {
        "value": null,
        "unit": "rank",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      }
    }
  ],
  "brands_named": [
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000002",
        "name": "Initech",
        "own": true
      },
      "visibility": {
        "value": 60,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "mean_position": {
        "value": 2,
        "unit": "rank",
        "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
      },
      "visibility": {
        "value": 30,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "mean_position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    }
  ],
  "sources": [],
  "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"
  },
  "replacement": null
}

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

promptId

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 and the answers counted, with a sentence saying so.

Show child attributes

prompt

object

required

Show child attributes

series

object

required

Show child attributes

by_engine

object[]

required

Show child attributes

brands_named

object[]

required

Show child attributes

sources

object[]

required

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

replacement

object | null

required

Show child attributes

⌘I

curl

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

import os
import requests

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

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/prompts/{promptId}", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await 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": 1,
    "answers": 30,
    "subtitle": "30 answers in the last 30 days",
    "customPromptsExcluded": true
  },
  "prompt": {
    "id": "p_acme_001",
    "text": "best 3PL software for a growing ecommerce brand",
    "intent": "compare",
    "scope": "category",
    "segments": [
      "wms"
    ],
    "facets": [],
    "status": "active",
    "first_run_date": "2026-11-04",
    "answers": 30,
    "visibility": {
      "value": 60,
      "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"
    }
  },
  "series": {
    "start": "2026-10-09",
    "interval": "day",
    "unit": "percent",
    "series": [
      {
        "label": "Initech",
        "brand_id": "00000000-0000-4000-8000-000000000002",
        "own": true,
        "values": [
          null,
          null,
          null
        ]
      },
      {
        "label": "Globex",
        "brand_id": "00000000-0000-4000-8000-000000000003",
        "own": false,
        "values": [
          null,
          null,
          null
        ]
      }
    ],
    "markers": []
  },
  "by_engine": [
    {
      "engine": "chatgpt",
      "visibility": {
        "value": 60,
        "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"
      }
    },
    {
      "engine": "google-ai-overview",
      "visibility": {
        "value": null,
        "unit": "percent",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      },
      "position": {
        "value": null,
        "unit": "rank",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      }
    },
    {
      "engine": "perplexity",
      "visibility": {
        "value": null,
        "unit": "percent",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      },
      "position": {
        "value": null,
        "unit": "rank",
        "band": null,
        "n": 0,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "no_data",
        "note": "needs one full run"
      }
    }
  ],
  "brands_named": [
    {
      "brand": {
        "id": "00000000-0000-4000-8000-000000000002",
        "name": "Initech",
        "own": true
      },
      "visibility": {
        "value": 60,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "mean_position": {
        "value": 2,
        "unit": "rank",
        "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
      },
      "visibility": {
        "value": 30,
        "unit": "percent",
        "band": null,
        "n": 30,
        "delta": null,
        "within_noise": true,
        "low_sample": false,
        "state": "measured"
      },
      "mean_position": {
        "value": 2,
        "unit": "rank",
        "band": null,
        "n": 9,
        "delta": null,
        "within_noise": true,
        "low_sample": true,
        "state": "measured"
      }
    }
  ],
  "sources": [],
  "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"
  },
  "replacement": null
}

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

Authorizations

Path Parameters

Query Parameters

Response