v1

latestOpenAPI 3.1.1Apache License 2.02026-07-17282768.2 KB
Stats

Get Property Stats

Get a list of custom properties and their stats. If a property name is provided, it will return the stats for that property instead.

get/website/{hostname}/properties

Path parameters

hostnamestring hostname required

Hostname for the website.

Query parameters

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

OK

namestring

Custom property name.

valuestring

Custom property value.

eventsinteger required

Number of events for custom property.

events_percentagenumber float required

Percentage of events for custom property relative to all events.