REST API / Collections

`keywords`

Collection

Brand, competitor and topic keywords configured for accessible projects.

Max rows per query: 100
Default order: id asc
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.	✓	–
`value`	`string`	Canonical match term.	✓	✓
`display_label` nullable	`string`	Display label.	✓	✓
`aliases`	`string[]`	Alternate match terms.	✓	–
`kind`	`string`	Keyword kind. `BRAND` `ALIAS` `PRODUCT` `COMPETITOR` `TOPIC`	✓	✓
`confirmed`	`boolean`	Whether confirmed for collection.	✓	✓
`enabled`	`boolean`	Whether enabled.	✓	✓
`source`	`string`	Creation source.	✓	✓
`created_at`	`datetime`	Creation time.	✓	✓
`last_run_at` nullable	`datetime`	Last successful scan.	✓	✓

Examples

Example

SELECT id, project_id, value, display_label, aliases
FROM keywords
ORDER BY id ASC
LIMIT 25

Calling it

MCP

Tool call

query({"sql":"SELECT id, project_id, value, display_label, aliases FROM keywords ORDER BY id ASC LIMIT 25"})

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, value, display_label, aliases FROM keywords ORDER BY id ASC LIMIT 25"
}
JSON

Row JSON Schema

json

{
  "type": "object",
  "description": "Brand, competitor and topic keywords configured for accessible projects.",
  "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": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": false
    },
    "value": {
      "type": "string",
      "description": "Canonical match term.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "display_label": {
      "type": [
        "string",
        "null"
      ],
      "description": "Display label.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "aliases": {
      "type": "array",
      "description": "Alternate match terms.",
      "items": {
        "type": "string"
      },
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": false,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": false
    },
    "kind": {
      "type": "string",
      "description": "Keyword kind.",
      "enum": [
        "BRAND",
        "ALIAS",
        "PRODUCT",
        "COMPETITOR",
        "TOPIC"
      ],
      "x-sensorhub-filter-operators": [
        "=",
        "!=",
        "<>",
        "IN",
        "NOT IN",
        "IS NULL",
        "IS NOT NULL"
      ],
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "confirmed": {
      "type": "boolean",
      "description": "Whether confirmed for collection.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether enabled.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "source": {
      "type": "string",
      "description": "Creation source.",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "created_at": {
      "type": "string",
      "description": "Creation time.",
      "format": "date-time",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    },
    "last_run_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last successful scan.",
      "format": "date-time",
      "x-sensorhub-indexed": false,
      "x-sensorhub-searchable": false,
      "x-sensorhub-aggregatable": true,
      "x-sensorhub-filterable": true,
      "x-sensorhub-sortable": true
    }
  },
  "additionalProperties": false
}