API explorerChangelog
Getting Started

Sections

API explorer
Changelog

Theme switcher

Traffic & Engagement

Returns traffic and engagement metrics over time for a specified domain.

Possible output fields:

  • visits: Estimated number of visits to the website
  • bounce_rate: Percentage of visits that view only one page on the website
  • average_visit_duration: Average time on website (in seconds)
  • pages_per_visit: Average number of pages viewed per visit
  • page_views: Estimated number of pages viewed on the website
  • unique_visitors: Estimated number of unique visitors (not deduplicated across devices) to the website
  • new_users: Estimated number of new users to the website
  • returning_users: Estimated number of returning users to the website

This endpoint uses data credits. Read the following guide to estimate the credit costs. 1 credit per metric per result. Maximum up to 8 credits per result when all metrics are requested.

Constraints:

  • unique_visitors can be requested only with monthly granularity.
  • new_users , returning_users can be requested only with monthly granularity & Total web device.

Header Parameters

api-keystring

Query Parameters

domainstring Required

Website domain without 'www.' (e.g., 'example.com')

start_datestring Required

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

end_datestring Required

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

granularitystring Required

Time granularity

Enum values:
dailyweeklymonthly
web_sourcestring

Specifies the web source device type

Enum values:
desktopmobile_webtotal
countrystring Required

Two-letter country code (e.g., 'us', 'gb', 'ww')

metricsarray

Comma-separated list of desired metrics. Default to all available metrics.

Enum values:
visitsaverage_visit_durationpages_per_visitbounce_ratepage_viewsunique_visitorsnew_usersreturning_users
mtdboolean

'true' sets end_date to the latest available day's data (month-to-date). Default is 'false'

main_domain_onlyboolean

'true' to include only the main domain, 'false' to include subdomains. Default is 'false'

formatstring

Format in which the reply should be returned.

Enum values:
jsonxml

Response

200
Object
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI