openapi: 3.2.0 info: title: Ahrefs Web Analytics API description: Ahrefs API v3 gives programmatic access to Ahrefs' SEO, marketing, and AI-search data — backlinks, organic and paid traffic, keywords, SERPs, rank tracking, site audits, brand/AI-search visibility, web and social analytics, and account management. This is the full spec for every tool; each tool also has its own spec under /reference/. termsOfService: https://ahrefs.com/terms contact: name: Ahrefs url: https://ahrefs.com/ email: support@ahrefs.com version: 3.0.0 servers: - url: https://api.ahrefs.com/v3 description: Ahrefs API v3 security: - http: - read tags: - name: Web Analytics description: Web_analytics. paths: /web-analytics/stats: get: tags: - Web Analytics summary: Stats description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.stats parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.stats' application/xml: schema: $ref: '#/components/schemas/web-analytics.stats' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/chart: get: tags: - Web Analytics summary: Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.chart parameters: - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/browsers: get: tags: - Web Analytics summary: Browsers description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.browsers parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.browsers' application/xml: schema: $ref: '#/components/schemas/web-analytics.browsers' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/browsers-chart: get: tags: - Web Analytics summary: Browsers Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.browsers-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: browser_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.browsers-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.browsers-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/browser-versions: get: tags: - Web Analytics summary: Browser Versions description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.browser-versions parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.browser-versions' application/xml: schema: $ref: '#/components/schemas/web-analytics.browser-versions' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/browser-versions-chart: get: tags: - Web Analytics summary: Browser Versions Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.browser-versions-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: browser_version_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.browser-versions-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.browser-versions-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/cities: get: tags: - Web Analytics summary: Cities description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.cities parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.cities' application/xml: schema: $ref: '#/components/schemas/web-analytics.cities' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/cities-chart: get: tags: - Web Analytics summary: Cities Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.cities-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: cities_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.cities-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.cities-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/continents: get: tags: - Web Analytics summary: Continents description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.continents parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.continents' application/xml: schema: $ref: '#/components/schemas/web-analytics.continents' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/continents-chart: get: tags: - Web Analytics summary: Continents Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.continents-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: continents_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.continents-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.continents-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/countries: get: tags: - Web Analytics summary: Countries description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.countries parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.countries' application/xml: schema: $ref: '#/components/schemas/web-analytics.countries' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/countries-chart: get: tags: - Web Analytics summary: Countries Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.countries-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: countries_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.countries-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.countries-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/devices: get: tags: - Web Analytics summary: Devices description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.devices parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.devices' application/xml: schema: $ref: '#/components/schemas/web-analytics.devices' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/devices-chart: get: tags: - Web Analytics summary: Devices Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.devices-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: devices_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.devices-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.devices-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/entry-pages: get: tags: - Web Analytics summary: Entry Pages description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.entry-pages parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.entry-pages' application/xml: schema: $ref: '#/components/schemas/web-analytics.entry-pages' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/entry-pages-chart: get: tags: - Web Analytics summary: Entry Pages Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.entry-pages-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: entry_pages_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.entry-pages-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.entry-pages-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/exit-pages: get: tags: - Web Analytics summary: Exit Pages description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.exit-pages parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.exit-pages' application/xml: schema: $ref: '#/components/schemas/web-analytics.exit-pages' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/exit-pages-chart: get: tags: - Web Analytics summary: Exit Pages Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.exit-pages-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: exit_pages_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.exit-pages-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.exit-pages-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/languages: get: tags: - Web Analytics summary: Languages description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.languages parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.languages' application/xml: schema: $ref: '#/components/schemas/web-analytics.languages' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/languages-chart: get: tags: - Web Analytics summary: Languages Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.languages-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: browser_language_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.languages-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.languages-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/operating-systems: get: tags: - Web Analytics summary: Operating Systems description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.operating-systems parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.operating-systems' application/xml: schema: $ref: '#/components/schemas/web-analytics.operating-systems' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/operating-systems-chart: get: tags: - Web Analytics summary: Operating Systems Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.operating-systems-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: os_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.operating-systems-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.operating-systems-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/operating-systems-versions: get: tags: - Web Analytics summary: Operating Systems Versions description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.operating-systems-versions parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.operating-systems-versions' application/xml: schema: $ref: '#/components/schemas/web-analytics.operating-systems-versions' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/operating-systems-versions-chart: get: tags: - Web Analytics summary: Operating Systems Versions Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.operating-systems-versions-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: os_versions_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.operating-systems-versions-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.operating-systems-versions-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/source-channels: get: tags: - Web Analytics summary: Source Channels description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.source-channels parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.source-channels' application/xml: schema: $ref: '#/components/schemas/web-analytics.source-channels' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/source-channels-chart: get: tags: - Web Analytics summary: Source Channels Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.source-channels-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: source_channels_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.source-channels-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.source-channels-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/sources: get: tags: - Web Analytics summary: Sources description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.sources parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.sources' application/xml: schema: $ref: '#/components/schemas/web-analytics.sources' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/sources-chart: get: tags: - Web Analytics summary: Sources Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.sources-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: sources_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.sources-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.sources-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/referrers: get: tags: - Web Analytics summary: Referrers description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.referrers parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.referrers' application/xml: schema: $ref: '#/components/schemas/web-analytics.referrers' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/referrers-chart: get: tags: - Web Analytics summary: Referrers Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.referrers-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: source_referers_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.referrers-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.referrers-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/top-pages: get: tags: - Web Analytics summary: Top Pages description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.top-pages parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.top-pages' application/xml: schema: $ref: '#/components/schemas/web-analytics.top-pages' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/top-pages-chart: get: tags: - Web Analytics summary: Top Pages Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.top-pages-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: pages_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.top-pages-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.top-pages-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/utm-params: get: tags: - Web Analytics summary: UTM Parameters description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.utm-params parameters: - description: The number of results to return. required: false explode: false schema: type: integer name: limit in: query - description: "Order by metric, as `metric:desc` or `metric:asc`. The following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer" required: false explode: false schema: type: string name: order_by in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Specify a UTM parameter to use as dimension. required: true explode: false schema: type: string enum: - utm_source - utm_medium - utm_campaign - utm_term - utm_content name: utm_param in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.utm-params' application/xml: schema: $ref: '#/components/schemas/web-analytics.utm-params' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' /web-analytics/utm-params-chart: get: tags: - Web Analytics summary: UTM Parameters Chart description: '>Requests to this endpoint are free and do not consume any API units.' operationId: web-analytics.utm-params-chart parameters: - description: Specify which values to chart (as a comma separated list), if not provided then `(top5-by-visitors)` is used by default (which charts top 5 values by visitor count). required: false explode: false schema: type: string name: utm_params_to_chart in: query - description: "Filter expression. Can mention dimensions and metrics.\n\nThe following dimensions are supported:\n\n**source_channel**: Source Channel \ntype: enum (search \\| llm \\| email \\| paid \\| search/paid \\| social \\| unknown \\| direct \\| newsletter \\| shopping/organic \\| shopping/paid \\| audio \\| social/paid \\| cross-network \\| mobile-push-notification \\| sms \\| affiliate \\| referral \\| display \\| internal)\n\n**source**: Source \ntype: string\n\n**source_referer**: Referer source \ntype: string\n\n**source_referer_domain**: Referer domain \ntype: string\n\n**utm_source**: UTM source \ntype: string\n\n**utm_medium**: UTM medium \ntype: string\n\n**utm_campaign**: UTM campaign \ntype: string\n\n**utm_term**: UTM term \ntype: string\n\n**utm_content**: UTM content \ntype: string\n\n**page**: Page URL \ntype: url\n\n**page_domain**: Page domain \ntype: string\n\n**page_title**: Page title \ntype: string\n\n**entry_page**: Entry page URL \ntype: url\n\n**exit_page**: Exit page URL \ntype: url\n\n**continent**: Continent \ntype: enum (AF \\| AS \\| EU \\| NA \\| OC \\| SA \\| AN \\| )\n\n**country**: Country \ntype: string\n\n**city**: City \ntype: string\n\n**browser_language**: Browser language \ntype: string\n\n**browser**: Browser \ntype: string\n\n**browser_version**: Browser version \ntype: string\n\n**os**: Operating system \ntype: string\n\n**os_version**: Operating system version \ntype: string\n\n**device**: Device type \ntype: string\n\n**screensize**: Screen size \ntype: string\n\n**event_name**: Event name \ntype: string\n\n**is_external_link_click**: Is external link click \ntype: boolean\n\n**event_prop:EVENT_PROP**: a custom event property can be specified by its name \ntype: string\n\nThe following metrics are supported:\n\n**pageviews**: Number of pageview events \ntype: integer\n\n**visitors**: Number of visitors \ntype: integer\n\n**visits**: Number of visits \ntype: integer\n\n**session_bounce_rate**: Session bounce rate (percentage of sessions that triggered only one request) \ntype: float\n\n**avg_session_length**: Average session length (in seconds) \ntype: float\n\n**avg_session_duration_sec**: Average session duration (in seconds) \ntype: integer\n\n**exit_rate**: Exit rate (percentage of pageviews that were the last in the session) \ntype: float\n\n**exits**: Number of exits \ntype: integer\n\n**entries**: Number of entries \ntype: integer\n\n**avg_page_visit_duration_sec**: Average page visit duration (in seconds) \ntype: integer\n\nFilter is a JSON string that represents a boolean expression, it should follow the following structure:\n```\n ::= { \"and\" : + }\n | { \"or\" : + }\n | { \"not\" : }\n | \n\n ::= {\n \"field\" : ,\n ? \"is\": ,\n }\n\n ::= [ \"eq\", ]\n | [ \"neq\", ]\n | [ \"gt\", ]\n | [ \"gte\", ]\n | [ \"lt\", ]\n | [ \"lte\", ]\n | [ \"substring\", ]\n | [ \"isubstring\", ]\n | [ \"phrase_match\", ]\n | [ \"iphrase_match\", ]\n | [ \"prefix\", ]\n | [ \"suffix\", ]\n```" required: false explode: false schema: type: string name: where in: query - description: Time granularity for chart data points. required: true explode: false schema: type: string enum: - hourly - daily - weekly - monthly name: granularity in: query - description: end datetime for the data query required: false explode: false schema: type: string format: date-time name: to in: query - description: start datetime for the data query required: false explode: false schema: type: string format: date-time name: from in: query - description: Specify a UTM parameter to use as dimension. required: true explode: false schema: type: string enum: - utm_source - utm_medium - utm_campaign - utm_term - utm_content name: utm_param in: query - description: Project ID required: true explode: false schema: type: integer name: project_id in: query - $ref: '#/components/parameters/web-analytics.output' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/web-analytics.utm-params-chart' application/xml: schema: $ref: '#/components/schemas/web-analytics.utm-params-chart' '400': $ref: '#/components/responses/web-analytics.error_400' '401': $ref: '#/components/responses/web-analytics.error_401' '403': $ref: '#/components/responses/web-analytics.error_403' '429': $ref: '#/components/responses/web-analytics.error_429' '500': $ref: '#/components/responses/web-analytics.error_500' components: schemas: web-analytics.source-channels-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source_channel: type: string enum: - search - llm - email - paid - search/paid - social - unknown - direct - newsletter - shopping/organic - shopping/paid - audio - social/paid - cross-network - mobile-push-notification - sms - affiliate - referral - display - internal title: source_channel description: Source Channel timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.exit-pages: properties: stats: items: properties: exit_page: type: string format: url title: exit_page description: Exit page URL exit_rate: type: number format: float title: exit_rate description: Exit rate (percentage of pageviews that were the last in the session) exits: type: integer title: exits description: Number of exits visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.continents-chart: properties: points: items: properties: continent: type: string enum: - AF - AS - EU - NA - OC - SA - AN - '' title: continent description: Continent timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.countries-chart: properties: points: items: properties: country: type: string title: country description: Country timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) avg_session_length: type: number format: float title: avg_session_length description: Average session length (in seconds) pageviews: type: integer title: pageviews description: Number of pageview events session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors visits: type: integer title: visits description: Number of visits type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.utm-params-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point utm_param: type: string title: utm_param description: UTM parameter value visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.entry-pages: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) entries: type: integer title: entries description: Number of entries entry_page: type: string format: url title: entry_page description: Entry page URL visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.entry-pages-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) entries: type: integer title: entries description: Number of entries entry_page: type: string format: url title: entry_page description: Entry page URL timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.browsers-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) browser: type: string title: browser description: Browser session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.operating-systems: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) os: type: string title: os description: Operating system session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.sources-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source: type: string title: source description: Source timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.stats: properties: stats: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) avg_session_length: type: number format: float title: avg_session_length description: Average session length (in seconds) pageviews: type: integer title: pageviews description: Number of pageview events session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors visits: type: integer title: visits description: Number of visits type: object type: object xml: name: AhrefsApiResponse web-analytics.devices: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) device: type: string title: device description: Device type session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.devices-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) device: type: string title: device description: Device type session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.cities: properties: stats: items: properties: city: type: string title: city description: City visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.languages-chart: properties: points: items: properties: browser_language: type: string title: browser_language description: Browser language timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.top-pages: properties: stats: items: properties: avg_page_visit_duration_sec: type: integer title: avg_page_visit_duration_sec description: Average page visit duration (in seconds) page: type: string format: url title: page description: Page URL pageviews: type: integer title: pageviews description: Number of pageview events session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.sources: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source: type: string title: source description: Source visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.languages: properties: stats: items: properties: browser_language: type: string title: browser_language description: Browser language visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.source-channels: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source_channel: type: string enum: - search - llm - email - paid - search/paid - social - unknown - direct - newsletter - shopping/organic - shopping/paid - audio - social/paid - cross-network - mobile-push-notification - sms - affiliate - referral - display - internal title: source_channel description: Source Channel visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.top-pages-chart: properties: points: items: properties: avg_page_visit_duration_sec: type: integer title: avg_page_visit_duration_sec description: Average page visit duration (in seconds) page: type: string format: url title: page description: Page URL pageviews: type: integer title: pageviews description: Number of pageview events session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.referrers-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source_referer: type: string title: source_referer description: Referer source timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.exit-pages-chart: properties: points: items: properties: exit_page: type: string format: url title: exit_page description: Exit page URL exit_rate: type: number format: float title: exit_rate description: Exit rate (percentage of pageviews that were the last in the session) exits: type: integer title: exits description: Number of exits timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.referrers: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) source_referer: type: string title: source_referer description: Referer source visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.browser-versions-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) browser_version: type: string title: browser_version description: Browser version session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.continents: properties: stats: items: properties: continent: type: string enum: - AF - AS - EU - NA - OC - SA - AN - '' title: continent description: Continent visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.utm-params: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) utm_param: type: string title: utm_param description: UTM parameter value visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.browser-versions: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) browser_version: type: string title: browser_version description: Browser version session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.Error_response: properties: error: type: string type: object xml: name: AhrefsApiResponse web-analytics.operating-systems-versions: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) os_version: type: string title: os_version description: Operating system version session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.browsers: properties: stats: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) browser: type: string title: browser description: Browser session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.operating-systems-versions-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) os_version: type: string title: os_version description: Operating system version session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.cities-chart: properties: points: items: properties: city: type: string title: city description: City timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.operating-systems-chart: properties: points: items: properties: avg_session_duration_sec: type: integer title: avg_session_duration_sec description: Average session duration (in seconds) os: type: string title: os description: Operating system session_bounce_rate: type: number format: float title: session_bounce_rate description: Session bounce rate (percentage of sessions that triggered only one request) timestamp: type: string title: timestamp description: Timestamp of the data point visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse web-analytics.countries: properties: stats: items: properties: country: type: string title: country description: Country visitors: type: integer title: visitors description: Number of visitors type: object type: array type: object xml: name: AhrefsApiResponse responses: web-analytics.error_401: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/web-analytics.Error_response' application/xml: schema: $ref: '#/components/schemas/web-analytics.Error_response' web-analytics.error_400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/web-analytics.Error_response' application/xml: schema: $ref: '#/components/schemas/web-analytics.Error_response' web-analytics.error_403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/web-analytics.Error_response' application/xml: schema: $ref: '#/components/schemas/web-analytics.Error_response' web-analytics.error_429: description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/web-analytics.Error_response' application/xml: schema: $ref: '#/components/schemas/web-analytics.Error_response' web-analytics.error_500: description: Internal Error content: application/json: schema: $ref: '#/components/schemas/web-analytics.Error_response' application/xml: schema: $ref: '#/components/schemas/web-analytics.Error_response' parameters: web-analytics.output: description: The output format. required: false explode: false schema: type: string enum: - json - csv - xml - php name: output in: query securitySchemes: http: type: http scheme: bearer