REST API / Collections

`citations`

CollectionLarge: filter on indexed fields

Citations scoped through the answer and prompt. Legacy UGC categories are represented as OTHER.

Max rows per query: 100
Default order: id asc
Required filter: one of project_id, id, answer_id
Max offset: 2000
Cursor paging: by id

Use read report_* for dashboard headline metrics and anchored comparison windows.

Fields

Field	Type	Description	Filter	Sort
`id` indexed	`string`	Unique row ID.	✓	✓
`project_id` indexed	`string`	Project ID from projects.	✓	–
`answer_id` indexed	`string`	Answer ID.	✓	✓
`url`	`string`	Cited URL.	–	–
`domain` indexed	`string`	Cited domain.	✓	✓
`title` nullable	`string`	Page title.	–	–
`anchor_text` nullable	`string`	Citation anchor.	–	–
`category` redacted	`string`	Source category. `EDITORIAL` `REVIEW` `DIRECTORY` `BRAND` `WIKIPEDIA` `SOCIAL` `COMMUNITY` `OTHER`	–	–
`page_type` nullable	`string`	Page type.	–	–
`position_in_answer`	`integer`	Citation position.	–	–
`is_own_domain`	`boolean`	Whether owned by the project brand.	–	–
`is_competitor_domain`	`boolean`	Owned by a tracked competitor	–	–
`competitor_name` nullable	`string`	Competitor name.	–	–
`opportunity_score` indexed	`number`	Opportunity score.	✓	✓
`published_at` nullable	`datetime`	Page publication time.	–	–
`starred` indexed	`boolean`	Whether starred.	✓	✓
`seen_at` nullable	`datetime`	When last marked seen.	–	–
`archived_at` nullable	`datetime`	When archived.	–	–

Examples

Example

SELECT id, project_id, answer_id, url, domain
FROM citations
WHERE project_id = $1
ORDER BY id ASC
LIMIT 25

Calling it

MCP

Tool call

query({"sql":"SELECT id, project_id, answer_id, url, domain FROM citations WHERE project_id = $1 ORDER BY id ASC LIMIT 25","params":["<value 1>"]})

REST

curl

curl -X POST "https://app.sensorhub.ai/api/v1/query" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "sql": "SELECT id, project_id, answer_id, url, domain FROM citations WHERE project_id = $1 ORDER BY id ASC LIMIT 25",
  "params": [
    "<value 1>"
  ]
}
JSON

Row JSON Schema

json

{
  "type": "object",
  "description": "Citations scoped through the answer and prompt. Legacy UGC categories are represented as OTHER.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique row ID.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "project_id": {
      "type": "string",
      "description": "Project ID from projects.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": false,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": false
    },
    "answer_id": {
      "type": "string",
      "description": "Answer ID.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "url": {
      "type": "string",
      "description": "Cited URL.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "domain": {
      "type": "string",
      "description": "Cited domain.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "Page title.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "anchor_text": {
      "type": [
        "string",
        "null"
      ],
      "description": "Citation anchor.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "category": {
      "type": "string",
      "description": "Source category.",
      "enum": [
        "EDITORIAL",
        "REVIEW",
        "DIRECTORY",
        "BRAND",
        "WIKIPEDIA",
        "SOCIAL",
        "COMMUNITY",
        "OTHER"
      ],
      "x-sensorhub-filter-operators": [],
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": false,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "page_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Page type.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "position_in_answer": {
      "type": "integer",
      "description": "Citation position.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "is_own_domain": {
      "type": "boolean",
      "description": "Whether owned by the project brand.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "is_competitor_domain": {
      "type": "boolean",
      "description": "Owned by a tracked competitor",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "competitor_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Competitor name.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "opportunity_score": {
      "type": "number",
      "description": "Opportunity score.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "published_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Page publication time.",
      "format": "date-time",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "starred": {
      "type": "boolean",
      "description": "Whether starred.",
      "x-sensorhub-indexed": true,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "seen_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When last marked seen.",
      "format": "date-time",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    },
    "archived_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When archived.",
      "format": "date-time",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": false,
      "x-sensorhub-sortable": false
    }
  },
  "additionalProperties": false
}