Skip to content
Lumen Insight Docs

Get Stats

GET /api/metrics

Section titled “ /api/metrics”

This endpoint allows you to get any time series statistics.

Query Parameters

Section titled “Query Parameters”

siteId Optional ID of the subsite to filter announcements by. Default is “main”.

startTimestamp Optional Unix Epoch format (millis). This is earliest timestamp to return.

endTimestamp Optional Unix Epoch format (millis). This is latest timestamp to return.
Default is the current time.

query Name of the stat to generate.

  • visitor_count
    Sum of all visitors that signed in (not including sign-outs) within the time range.
    This counts each visit, so will be more than one if the same visitor signed in multiple times in one day or multiple days.

  • registered_visitor_count
    Sum of all registered visitors that signed in (not including sign-outs) within the time range.
    This counts each visit, so will be more than one if the same visitor signed in multiple times in one day or multiple days.

  • unique_visitor_count
    Sum of all unique visitors that signed in (not including sign-outs) within the time range.
    This counts each visitor only once, so will be less than or equal to visitor_count.

  • unique_registered_visitor_count
    Sum of all unique registered visitors that signed in (not including sign-outs) within the time range.
    This counts each visitor only once, so will be less than or equal to registered_visitor_count.

  • registration_count
    Sum of all registration form responses submitted within the time range.

Response Body

Section titled “Response Body”
{
    "value": number,
    "query": string,
    "startTimestampIso": string | null,
    "endTimestampIso": string | null,
    "windowLengthDays": number | null,
    "durationMs": number
}

value The value of the statistic.

query Name of the statistic that was requested. (same as query parameter)

startTimestampIso Nullable ISO 8601 format. Same as startTimestamp parameter.

endTimestampIso Nullable ISO 8601 format. Same as endTimestamp parameter.

windowLengthDays Nullable How many days are included in the time range.

durationMs How long it took to generate the statistic in milliseconds.