Retrieve Grouped Page Views Analytics

get

https://api.arena.im/v3/analytics/grouped/pageviews

Fetches a paginated list of page view analytics grouped by specified criteria, with filtering and sorting options.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter[idType]

string

enum

Defaults to siteId

Type of ID to filter by (e.g., site, chat room, event, or conversion card)

Allowed:

filter[id]

string

required

The unique ID of the site, chat room, event, or conversion card to analyze

filter[dateStart]

string

required

Start date for the analytics data range (inclusive)

filter[dateEnd]

string

required

End date for the analytics data range (inclusive)

filter[groupField]

string

enum

Defaults to widgetId

Field to group the analytics data by (e.g., widgetId, siteId)

Allowed:

type

string

enum

Defaults to page

Type of page view to analyze (e.g., 'page' or 'track')

Allowed:

resolution

string

enum

Defaults to total

Time resolution for grouping page views (e.g., 'total', 'hour', 'day')

Allowed:

sort

string

Sort the results by specified fields (e.g., '-total' for descending order by total views)

page[offset]

number

≥ 0

Defaults to 0

Number of records to skip for pagination.

Minimum: 0

page[limit]

number

0 to 100

Defaults to 10

Number of records to return per page.

Minimum: 0

Maximum: 100

Responses

401

Unauthorized due to missing or expired authentication token

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved the grouped page views analytics