Stats

Get Page Stats

Get a list of pages and their stats.

get/website/{hostname}/pages

Path parameters

hostnamestring hostname required

Hostname for the website.

Query parameters

summaryboolean

Return a summary of the stats.

startstring date-time

Period start date using date-time notation in RFC3339 format, for example, (2017-07-21T17:32:28Z).

endstring date-time

Period end date using fdate-time notation in RFC3339 format, for example, (2017-07-21T17:32:28Z).

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Path of the page.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Referrer URL of the page hit.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

UTM source of the page hit.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

UTM medium of the page hit.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

UTM campaign of the page hit.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Browser name.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Operating system name.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Device type.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Country name.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Language code.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Name of the property.

eqstring

Equal to.

neqstring

Not equal to.

containsstring

Contains.

not_containsstring

Does not contain.

starts_withstring

Starts with.

not_starts_withstring

Does not start with.

ends_withstring

Ends with.

not_ends_withstring

Does not end with.

instring

In.

not_instring

Not in.

Value of the property.

limitinteger

Limit the number of results.

offsetinteger

Offset the results paired with the limit parameter.

Cookies

_me_sessstring required

Example:_me_sess=token; Path=/; HttpOnly; SameSite=Lax; Secure

Session token for authentication.

Response

pathstring required

Pathname of the page.

visitorsinteger required

Number of unique visitors for given page.

visitors_percentagenumber float required

Percentage of unique visitors for given page relative to all visitors.

pageviewsinteger

Number of page views.

pageviews_percentagenumber float

Percentage of page views relative to all pages.

bounce_percentagenumber float

Bounce rate percentage.

durationinteger

Total time spent on page in milliseconds.

Changes

Changed in 18 of the 50 revisions of this API.133239

Sep 4, 2024251a51c1c9325See the full diff
- ●
  the optional response header X-API-Commit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-API-Commit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-API-Commit removed for the status 401
  optional-response-header-removed
- ●
  the optional response header X-API-Commit removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-API-Commit removed for the status 500
  optional-response-header-removed
Aug 25, 2024a73676f07ad52See the full diff
- ○
  added the new optional query request parameter prop_name
  new-optional-request-parameter
- ○
  added the new optional query request parameter prop_value
  new-optional-request-parameter
Jul 7, 2024218fcb69a8b011See the full diff
- ●
  removed the optional property items/bounces from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/bounce_percentage to the response with the 200 status
  response-optional-property-added
Jun 30, 2024860d419093ef2See the full diff
- ○
  api tag Stats added
  api-tag-added
- ○
  api tag stats removed
  api-tag-removed
Feb 25, 202489302591c0011See the full diff
- ●
  deleted the query request parameter interval
  request-parameter-removed
Feb 23, 20247e58a00a419e22See the full diff
- ▲
  for the query request parameter limit, default value 5 was removed
  request-parameter-default-value-removed
- ▲
  for the query request parameter offset, default value 0 was removed
  request-parameter-default-value-removed
- ○
  for the query request parameter limit, the max was increased from 500.00 to 5000.00
  request-parameter-max-increased
- ○
  for the query request parameter offset, the max was increased from 500.00 to 5000.00
  request-parameter-max-increased
Feb 16, 20247faed8d7ec932See the full diff
- ○
  for the query request parameter end, the type/format was generalized from string/date to string/date-time
  request-parameter-type-generalized
- ○
  for the query request parameter start, the type/format was generalized from string/date to string/date-time
  request-parameter-type-generalized
Feb 15, 20249268015cf1781See the full diff
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
Feb 3, 2024dda4cecf2e5a1See the full diff
- ○
  for the query request parameter limit, the type/format was generalized from integer/int32 to integer/
  request-parameter-type-generalized
Jan 30, 2024b3fcc629d09823See the full diff
- ▲
  removed the required property items/unique_percentage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/uniques from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property items/pageviews_percentage to the response with the 200 status
  response-optional-property-added
- ○
  added the required property items/visitors to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/visitors_percentage to the response with the 200 status
  response-required-property-added

Full history (18 revisions)