Skip to main content
GET
Get topic cluster details
Returns detailed information about a specific topic including all linked keywords, prompts, visibility trends, and performance insights. Query parameters: teamId, and a reporting window as startDate and endDate (YYYY-MM-DD) or days (see Date Windows). Send only endDate for All Time: the window starts at the first stored data point (search data is capped at 480 days) and has no previous-period change. The response has topic, overview, trend, performance, keywords, and prompts. Returns 404 if the topic does not exist for the team.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Path Parameters

topicId
string
required

Topic cluster ID

Query Parameters

teamId
string

Team ID

page
integer

1-based page. Default 1.

pageSize
string

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

view
enum<string>
Available options:
overview,
keywords,
prompts
category
enum<string>
Available options:
All,
Ranked,
Mentioned
sortBy
enum<string>
Available options:
keyword,
position,
impressions,
clicks,
positionDelta,
impressionsChangePct,
clicksChangePct,
prompt,
shareOfVoice,
mentions
sortDir
enum<string>
Available options:
asc,
desc
days
integer
default:30

Days back from today on the team's calendar, converted to startDate/endDate. Ignored when startDate or endDate is set. Defaults to 30.

Required range: x >= 1
startDate
string

Window start date (YYYY-MM-DD on the team's calendar). days is ignored when a date is sent. A start with no end runs to today; omit with endDate for All Time.

endDate
string

Window end date (YYYY-MM-DD on the team's calendar). days is ignored when a date is sent.

Response

Default Response

topic
object
overview
object
trend
object
performance
object
page
integer
pageSize
integer
total
integer
totalPages
integer
summary
object
items
object[]
keywords
object[]
prompts
object[]