#### 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:
* `new_users` , `returning_users` can be requested only with `monthly` granularity & `Total` web device.
{
"endpoints": {
"method": "get",
"path": "v5/website-analysis/websites/traffic-and-engagement"
},
"request": {
"query": [
{
"name": "domain",
"description": "Website domain without 'www.' (e.g., 'example.com')",
"isRequired": true,
"valueType": "string",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "start_date",
"description": "Start date in 'YYYY-MM' or 'YYYY-MM-DD' format",
"isRequired": false,
"valueType": "string",
"options": {
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "end_date",
"description": "End date in 'YYYY-MM' or 'YYYY-MM-DD' format",
"isRequired": false,
"valueType": "string",
"options": {
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "granularity",
"description": "Time granularity",
"isRequired": false,
"value": "Monthly",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "daily"
},
{
"value": "weekly"
},
{
"value": "monthly"
}
],
"example": "Monthly",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "web_source",
"description": "Specifies the web source device type",
"isRequired": false,
"value": "desktop",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "desktop"
},
{
"value": "mobile_web"
},
{
"value": "total"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "country",
"description": "Two-letter country code (e.g., 'us', 'gb', 'ww')",
"isRequired": false,
"value": "us",
"valueType": "string",
"options": {
"example": "us",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "metrics",
"description": "Comma-separated list of desired metrics. Default to all available metrics.",
"isRequired": false,
"valueType": "array",
"options": {
"enumValue": [
{
"value": "visits"
},
{
"value": "average_visit_duration"
},
{
"value": "pages_per_visit"
},
{
"value": "bounce_rate"
},
{
"value": "page_views"
},
{
"value": "unique_visitors"
},
{
"value": "new_users"
},
{
"value": "returning_users"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "mtd",
"description": "'true' sets end_date to the latest available day's data (month-to-date). Default is 'false'",
"isRequired": false,
"valueType": "boolean",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "main_domain_only",
"description": "'true' to include only the main domain, 'false' to include subdomains. Default is 'false'",
"isRequired": false,
"valueType": "boolean",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "format",
"description": "Format in which the reply should be returned. ",
"isRequired": false,
"value": "json",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "json"
},
{
"value": "xml"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
],
"body": [],
"header": [
{
"name": "api-key",
"isRequired": false,
"value": "YOUR_API_KEY",
"valueType": "string",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
],
"path": [],
"contentType": "application/json",
"graphqlQuery": "",
"codeExamples": [],
"auth": [],
"_id": "6a980b7cc0e28311fa0d6894"
},
"responses": [
{
"statusCode": 200,
"description": "Success",
"contentType": "application/json",
"body": [
{
"name": "meta",
"description": "",
"isRequired": false,
"value": "",
"valueType": "object",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": [
{
"name": "request",
"description": "",
"isRequired": false,
"value": "",
"valueType": "object",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": [
{
"name": "format",
"description": "Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'",
"isRequired": false,
"value": "json",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "json"
},
{
"value": "xml"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "domain",
"description": "Website domain without 'www.' (e.g., 'example.com')",
"isRequired": true,
"value": "chatgpt.com",
"valueType": "string",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "start_date",
"description": "Start date in 'YYYY-MM' or 'YYYY-MM-DD' format",
"isRequired": false,
"value": "2025-07",
"valueType": "string",
"options": {
"nullable": true,
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "end_date",
"description": "End date in 'YYYY-MM' or 'YYYY-MM-DD' format",
"isRequired": false,
"value": "2025-07",
"valueType": "string",
"options": {
"nullable": true,
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "granularity",
"description": "Time granularity ",
"isRequired": false,
"value": "monthly",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "daily"
},
{
"value": "weekly"
},
{
"value": "monthly"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "web_source",
"description": "Web Source to fetch data for",
"isRequired": false,
"value": "total",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "desktop"
},
{
"value": "mobile_web"
},
{
"value": "total"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "country",
"description": "Two-letter country code (e.g., 'us', 'gb', 'ww')",
"isRequired": false,
"value": "us",
"valueType": "string",
"options": {
"nullable": true,
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "metrics",
"description": "Comma-separated list of metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, page_views, unique_visitors, new_users, returning_users",
"isRequired": false,
"value": "",
"valueType": "array",
"options": {
"nullable": true,
"enumValue": [
{
"value": "visits"
},
{
"value": "average_visit_duration"
},
{
"value": "pages_per_visit"
},
{
"value": "bounce_rate"
},
{
"value": "page_views"
},
{
"value": "unique_visitors"
},
{
"value": "new_users"
},
{
"value": "returning_users"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": [
{
"name": "0",
"description": "Comma-separated list of metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, page_views, unique_visitors, new_users, returning_users",
"isRequired": false,
"value": "visits, bounce_rate, average_visit_duration",
"valueType": "string",
"options": {
"nullable": true,
"enumValue": [
{
"value": "visits"
},
{
"value": "average_visit_duration"
},
{
"value": "pages_per_visit"
},
{
"value": "bounce_rate"
},
{
"value": "page_views"
},
{
"value": "unique_visitors"
},
{
"value": "new_users"
},
{
"value": "returning_users"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
]
},
{
"name": "mtd",
"description": "'true' sets end_date to the latest available day's data (month-to-date). Default is 'false'",
"isRequired": false,
"value": false,
"valueType": "boolean",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "main_domain_only",
"description": "'true' to include only the main domain, 'false' to include subdomains. Default is 'false'",
"isRequired": false,
"value": false,
"valueType": "boolean",
"options": {
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
]
},
{
"name": "status",
"description": "",
"isRequired": false,
"value": "success",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "success"
},
{
"value": "error"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "error_code",
"description": "",
"isRequired": false,
"value": null,
"valueType": "integer",
"options": {
"nullable": true,
"format": "int32",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "error_message",
"description": "",
"isRequired": false,
"value": "",
"valueType": "string",
"options": {
"nullable": true,
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "last_updated",
"description": "",
"isRequired": false,
"value": "",
"valueType": "string",
"options": {
"nullable": true,
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "data_type",
"description": "",
"isRequired": false,
"value": "not_applicable",
"valueType": "string",
"options": {
"enumValue": [
{
"value": "not_applicable"
},
{
"value": "estimated"
},
{
"value": "verified"
}
],
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
]
},
{
"name": "data",
"description": "",
"isRequired": false,
"value": "",
"valueType": "array",
"options": {
"nullable": true,
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": [
{
"name": "0",
"description": "",
"isRequired": false,
"value": "",
"valueType": "object",
"options": {
"nullable": true,
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": [
{
"name": "date",
"description": "",
"isRequired": false,
"value": "2025-07-01",
"valueType": "string",
"options": {
"format": "date-time",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "visits",
"description": "Estimated number of visits to the website",
"isRequired": false,
"value": "863759115.0635419",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "bounce_rate",
"description": "Percentage of visits that view only one page on the website",
"isRequired": false,
"value": "0.2755711666536945",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "average_visit_duration",
"description": "Average time on website (in seconds)",
"isRequired": false,
"value": "386.4105809929018",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "pages_per_visit",
"description": "Average number of pages viewed per visit",
"isRequired": false,
"value": "3.7262894284076107",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "page_views",
"description": "Estimated number of pages viewed on the website",
"isRequired": false,
"value": "3218616459.151989",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "unique_visitors",
"description": "Estimated number of unique visitors (not deduplicated across devices) to the website",
"isRequired": false,
"value": "66083533.010000005",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "new_users",
"description": "Estimated number of new users to the website",
"isRequired": false,
"value": "11702160.986578166",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
},
{
"name": "returning_users",
"description": "Estimated number of returning users to the website",
"isRequired": false,
"value": "54381372.02597107",
"valueType": "number",
"options": {
"nullable": true,
"format": "double",
"xml": {
"prefix": null
},
"schemaNames": []
},
"complexItems": [],
"items": []
}
]
}
]
}
]
}
],
"showBaseUrl": false,
"showLanguageBox": false,
"showRequestDescription": true,
"showResponseDescription": true,
"errorCodes": [],
"statusCodes": [],
"dataExample": [],
"endpointSummary": [],
"endpointSummaryShowParams": true,
"errorCodesDisplayOnRight": true,
"statusCodesDisplayOnRight": true
}