Skip to main content
GET
Citations

Authorizations

Authorization
string
header
required

Siteline public API key. Create one under Team settings > Public API Key.

Path Parameters

productId
integer
required

Product ID returned by GET /v1/products.

Example:

42

Query Parameters

domain
string
required

Product domain to report metrics for, such as example.com.

Example:

"example.com"

dateFrom
string<date-time>
required

Inclusive start timestamp in RFC3339 format.

Example:

"2026-05-01T00:00:00Z"

dateTo
string<date-time>
required

Inclusive end timestamp in RFC3339 format.

Example:

"2026-05-31T23:59:59Z"

platforms[]
string[]

Platform filters. Common values: openai, gemini, google, perplexity, google_ai_overviews, claude.

labelIds[]
integer[]

Prompt label IDs to filter on. Invalid IDs return 400.

groupBy
enum<string>
default:all

Group citations by dimension. all returns all three grouped arrays.

Available options:
all,
property,
page,
product

Response

Citation metrics grouped by the selected dimension.

Citation metrics grouped by the selected dimension. When groupBy targets a single dimension, only that top-level field is present.

byProperty
object[]
byPage
object[]
byProduct
object[]