# Web Analytics ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /{version}/api/get/web-analysis/list: post: summary: Web Analytics deprecated: false description: Unified view of spend, engagement, and conversion funnel performance. tags: - Public API/Attribution/Web Analytics parameters: - name: version in: path description: v2-4-2 required: true example: v2-4-2 schema: type: string - name: ApiKey in: header description: '' required: true example: '{{ApiKey}}' schema: type: string default: '{{ApiKey}}' requestBody: content: application/json: schema: type: object properties: start_date: type: string description: >- The start date range of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings. x-apifox-mock: '2026-03-01' end_date: type: string description: >- The end date of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.If you want to see the data for 1970-01-01, please enter 1970-01-02. x-apifox-mock: '2026-03-16' dimensions: type: array items: type: string description: |- - campaign - channel - source - medium -landing_page x-apifox-mock: channel description: >- The input quantity should not exceed 3, campaign/channel/source/medium/landing_page. search: type: string description: search string filters: type: array items: type: object properties: column: type: string description: '- landing_page' x-apifox-mock: landing_page operation: type: string description: equal x-apifox-mock: equal values: type: array items: type: string x-apifox-mock: / x-apifox-orders: - column - operation - values description: column=landing_page, operation=equal, values=landing_page sorts: type: array items: type: object properties: column: type: string description: |- - spend - unique_users - returning_users - total_sessions - engagement_rate - homepage_view_users - product_view_users - atc_users - purchases - purchases_rate - revenue x-apifox-mock: revenue order: type: string description: |- - desc - asc x-apifox-mock: desc x-apifox-orders: - column - order page: type: string x-apifox-mock: '1' description: page page_size: type: string x-apifox-mock: '20' description: page size min:1 , max:20 required: - start_date - end_date - dimensions - sorts - page - page_size x-apifox-orders: - start_date - end_date - dimensions - search - filters - sorts - page - page_size example: start_date: '2026-03-01' end_date: '2026-03-16' dimensions: - channel filters: - column: landing_page operation: equal values: - / sorts: - column: revenue order: desc page: '1' page_size: '20' responses: '200': description: '' content: application/json: schema: type: object properties: code: type: integer description: '1: success , other: fail' message: type: string description: message data: type: object properties: total: type: integer description: total page_size: type: integer description: page size records: type: array items: type: object properties: channel: type: string description: channel utm_campaign: type: string description: utm campaign utm_source: type: string description: utm source utm_medium: type: string description: utm medium landing_page: type: string description: landing page spend: type: integer description: spend unique_users: type: integer description: unique users returning_users: type: integer description: returning users total_sessions: type: integer description: total sessions event_per_session: type: integer description: event per session engagement_rate: type: integer description: engagement rate homepage_view_users: type: integer description: homepage view users product_view_users: type: integer description: product view users atc_users: type: integer description: atc users purchases: type: integer description: purchases purchases_rate: type: integer description: purchases rate revenue: type: integer description: revenue x-apifox-orders: - channel - utm_campaign - utm_source - utm_medium - landing_page - spend - unique_users - returning_users - total_sessions - event_per_session - engagement_rate - homepage_view_users - product_view_users - atc_users - purchases - purchases_rate - revenue required: - total - page_size - records x-apifox-orders: - total - page_size - records required: - code - message - data x-apifox-orders: - code - message - data example: code: 1 message: ok data: total: 11 page_size: 99 records: - channel: cillum veniam utm_campaign: ad utm_source: officia utm_medium: dolore dolor cillum in landing_page: sit aute ut spend: 10 unique_users: 23 returning_users: 28 total_sessions: 66 event_per_session: 87 engagement_rate: 82 homepage_view_users: 78 product_view_users: 5 atc_users: 96 purchases: 79 purchases_rate: 17 revenue: 26 - channel: incididunt ullamco commodo adipisicing sunt utm_campaign: minim deserunt sunt incididunt utm_source: Ut ut utm_medium: laborum qui velit amet landing_page: in Lorem esse Duis spend: 9 unique_users: 35 returning_users: 52 total_sessions: 8 event_per_session: 26 engagement_rate: 54 homepage_view_users: 18 product_view_users: 93 atc_users: 92 purchases: 78 purchases_rate: 90 revenue: 19 - channel: nisi non utm_campaign: dolore occaecat dolor officia utm_source: pariatur officia utm_medium: do reprehenderit landing_page: enim nostrud spend: 48 unique_users: 26 returning_users: 68 total_sessions: 28 event_per_session: 56 engagement_rate: 38 homepage_view_users: 74 product_view_users: 8 atc_users: 27 purchases: 56 purchases_rate: 32 revenue: 72 headers: {} x-apifox-name: Success security: [] x-apifox-folder: Public API/Attribution/Web Analytics x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/7934002/apis/api-429980010-run components: schemas: {} securitySchemes: {} servers: - url: https://data-api.test.attribuly.com description: test - url: https://data.api.attribuly.com description: prod security: [] ```