Stats

Get Country Stats

Changed on

Get a list of countries and their stats.

get/website/{hostname}/countries

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/website/{hostname}/countries
  • Auth
    API key in cookie _me_sess

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

OK

countrystring required

Country name.

visitorsinteger required

Number of unique visitors from country.

visitors_percentagenumber float required

Percentage of unique visitors from country relative to all visitors.

bounce_percentagenumber float

Bounce rate percentage from country.

durationinteger

Total time spent on page from country in milliseconds.

Changes

  • 251a51c1c932Revision changes
    • warning

      the optional response header X-API-Commit removed for the status 200

    • warning

      the optional response header X-API-Commit removed for the status 400

    • warning

      the optional response header X-API-Commit removed for the status 401

    • warning

      the optional response header X-API-Commit removed for the status 403

    • warning

      the optional response header X-API-Commit removed for the status 404

    • warning

      the optional response header X-API-Commit removed for the status 500

  • a73676f07ad5Revision changes
    • info

      added the new optional query request parameter prop_name

    • info

      added the new optional query request parameter prop_value