Topic Clusters

Get topic cluster details

Changed on

Returns full details for a topic cluster including keywords, prompts, and performance.

get/v3/topic-clusters/{topicId}

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/topic-clusters/{topicId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

topicIdstring required

Topic cluster ID

Query parameters

teamIdstring

Team ID

pageinteger

1-based page. Default 1.

pageSizestring

Rows per page (max 1000), or 'all'. Every response reports total and totalPages.

view'overview' | 'keywords' | 'prompts'
searchstring
category'All' | 'Ranked' | 'Mentioned'
sortBy'keyword' | 'position' | 'impressions' | 'clicks' | 'positionDelta' | 'impressionsChangePct' | 'clicksChangePct' | 'prompt' | 'shareOfVoice' | 'mentions'
sortDir'asc' | 'desc'
daysstring

Legacy rolling-window fallback (number of days). Prefer startDate + endDate.

startDatestring

Window start date (YYYY-MM-DD, UTC). Takes precedence over days. Omit with endDate for All Time.

endDatestring

Window end date (YYYY-MM-DD, UTC). Takes precedence over days.

Response

Default Response

topicobject
overviewobject
trendobject
performanceobject
pagenumber
pageSizenumber
totalnumber
totalPagesnumber
summaryobject
itemsobject[]
keywordsobject[]
promptsobject[]

Changes

  • 7ede4ba45814Revision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pageSize

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter view

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status