list_topics

List all visibility topics and their queries for a brand. Topics group related search queries that are used in visibility scans.

Authentication: Required

Parameters

Parameter	Type	Required	Description
`syntheticId`	`integer`	Yes	The agent ID to list topics for.

Response

{
  "syntheticId": 1234,
  "brandName": "Example",
  "topicCount": 3,
  "queryCount": 18,
  "topics": [
    {
      "id": "topic-1",
      "name": "Core Product",
      "description": "Direct queries about Example's product and capabilities",
      "isActive": true,
      "queries": [
        {
          "id": "q-1",
          "query": "What is Example?",
          "reachLevel": "core",
          "isActive": true
        },
        {
          "id": "q-2",
          "query": "Best AI visibility monitoring tools",
          "reachLevel": "adjacent",
          "isActive": true
        }
      ]
    }
  ]
}

Key fields

Field	Description
`topicCount`	Number of topics
`queryCount`	Total queries across all topics
`topics[].isActive`	Whether this topic is included in scans
`queries[].reachLevel`	`"core"`, `"adjacent"`, `"aspirational"`, or `"visionary"`
`queries[].isActive`	Whether this query is included in scans

Parameters

Response

Key fields

On this page