# Fetch Sitewide Analytics

## POST /v25-10-beta/analytics/sitewide/order-distribution

> Retrieve order value distribution data and unit mix breakdowns for a time window.\
> \
> The response returns \`orderValueDistribution.kernel\_density\_estimate\` and \`orderValueDistribution.cumulative\_distribution\_function\`, plus \`orderBreakdown\`.

```json
{"openapi":"3.1.0","info":{"title":"Intelligems External API v25-10-beta","version":"v25-10-beta"},"tags":[{"name":"Fetch Sitewide Analytics"}],"servers":[{"url":"https://api.intelligems.io","description":"Production"}],"security":[{"intelligems_access_token":[]}],"components":{"securitySchemes":{"intelligems_access_token":{"type":"apiKey","in":"header","name":"intelligems-access-token","description":"Intelligems external API access token."}}},"paths":{"/v25-10-beta/analytics/sitewide/order-distribution":{"post":{"tags":["Fetch Sitewide Analytics"],"description":"Retrieve order value distribution data and unit mix breakdowns for a time window.\n\nThe response returns `orderValueDistribution.kernel_density_estimate` and `orderValueDistribution.cumulative_distribution_function`, plus `orderBreakdown`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"description":"Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"end":{"description":"End of analysis period as an ISO 8601 datetime string. Defaults to now.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"filters":{"description":"Optional analytics filters object. See the Filters Reference for available filter fields.","type":"object","properties":{"deviceType":{"description":"Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.","anyOf":[{"type":"string","enum":["any","mobile","desktop"]},{"type":"null"}]},"visitorType":{"description":"Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.","anyOf":[{"type":"string","enum":["any","new","returning"]},{"type":"null"}]},"sourceSitesOrChannels":{"description":"Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.","type":"array","items":{"type":"string","enum":["Referral","All Social","Organic Social","Paid Social","Organic Search","Paid Search","Paid Shopping","Email","Google","Facebook","Instagram","Linktree","TikTok","Twitter","Direct","SMS","Other","Meta","Link Tree","Wunderkind Text","Youtube","any"]}},"landingPage":{"description":"Filter by landing page URL path. Object with: landingPageUrlPath (string|null — the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).","anyOf":[{"type":"object","properties":{"landingPageUrlPath":{"anyOf":[{"type":"string"},{"type":"null"}]},"landingPageUrlPathFilterType":{"anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]},{"type":"null"}]}},"required":["landingPageUrlPath","landingPageUrlPathFilterType"]},{"type":"null"}]},"landingPageFilters":{"description":"Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against — omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.","type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"filterType":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]}},"required":["filterType"]}},"landingPageFiltersOperator":{"description":"How multiple items in landingPageFilters are combined. 'or' (default) — session matches if any filter item matches. 'and' — session must match every filter item.","type":"string","enum":["or","and"]},"countryCodes":{"description":"Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.","type":"array","items":{"type":"string"}},"maxZScore":{"description":"Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.","anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"landingPageTypes":{"description":"Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.","type":"array","items":{"type":"string","enum":["PDP","Collection","Content","Blog","Homepage","Search","Cart","Other"]}},"allOrders":{"description":"Whether to include all orders or only matched orders.","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","headers":{"access-control-allow-origin":{"schema":{"type":"string"},"description":"CORS allow-origin header."},"access-control-allow-credentials":{"schema":{"type":"string"},"description":"CORS allow-credentials header."},"content-type":{"schema":{"type":"string"},"description":"Response content type."},"Timing-Allow-Origin":{"schema":{"type":"string"},"description":"Allowed origin for Timing headers."}},"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"ISO 4217 currency code for monetary values (e.g. 'USD')."},"orderValueDistribution":{"type":"object","properties":{"kernel_density_estimate":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"current_period":{"type":"number"},"previous_period":{"type":"number"}},"required":["x","current_period","previous_period"],"additionalProperties":false},"description":"Kernel density estimation curve points for order value distribution. Each point has an `x` (order value), `current_period`, and `previous_period` field."},"cumulative_distribution_function":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"current_period":{"type":"number"},"previous_period":{"type":"number"}},"required":["x","current_period","previous_period"],"additionalProperties":false},"description":"Cumulative distribution function curve points for order value distribution. Each point has an `x` (order value), `current_period`, and `previous_period` field."}},"required":["kernel_density_estimate","cumulative_distribution_function"],"additionalProperties":false,"description":"Order value distribution object containing `kernel_density_estimate` and `cumulative_distribution_function` arrays. Each point has an `x` (order value), `current_period`, and `previous_period` field."},"orderBreakdown":{"type":"array","items":{"type":"object","properties":{"unit_quantity":{"type":"number"},"n_orders":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false},"net_revenue":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false},"gross_profit":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false},"pct_orders_by_unit_quantity":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false},"pct_revenue_by_unit_quantity":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false},"pct_profit_by_unit_quantity":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["value"],"additionalProperties":false}},"required":["unit_quantity","n_orders","net_revenue","gross_profit","pct_orders_by_unit_quantity","pct_revenue_by_unit_quantity","pct_profit_by_unit_quantity"],"additionalProperties":false},"description":"Breakdown of orders, revenue, and profit by number of units per order. Each entry has unit_quantity and metric values (n_orders, net_revenue, gross_profit as value objects, plus percentage equivalents)."}},"required":["currency","orderValueDistribution","orderBreakdown"],"additionalProperties":false}}}}}}}}}
```

## POST /v25-10-beta/analytics/sitewide/snapshot

> Retrieve sitewide snapshot metrics for a time window.\
> \
> The optional \`feature\` parameter is an object, not a string enum.\
> \
> Use \`{ "name": "performance" }\` for the core KPI subset, \`{ "name": "audience", "audience": "device\_type" }\` for audience snapshots, \`{ "name": "order" }\` for order-focused snapshot metrics, or \`{ "name": "conversion" }\` for conversion funnel snapshot metrics. Omitting \`feature\` entirely returns the full sitewide metric set.\
> \
> \### Response Structure\
> \
> The response is a JSON object keyed by segment name, \*\*not\*\* a flat object with top-level metric fields.\
> \
> When no audience feature is specified (or \`feature.name\` is \`"performance"\`, \`"order"\`, or \`"conversion"\`), the response contains a single \`"All"\` key:\
> \
> \`\`\`json\
> {\
>   "All": {\
>     "currency": "USD",\
>     "n\_visitors": { "value": 52763, "pct\_change": 0.12 },\
>     "conversion\_rate": { "value": 0.034, "pct\_change": -0.05 },\
>     ...\
>   }\
> }\
> \`\`\`\
> \
> When \`feature.name\` is \`"audience"\`, the response contains one key per audience segment plus a \`"\_\_total"\` key:\
> \
> \`\`\`json\
> {\
>   "Desktop": { "currency": "USD", "n\_visitors": { "value": 30000, "pct\_change": 0.08 }, ... },\
>   "Mobile": { "currency": "USD", "n\_visitors": { "value": 22763, "pct\_change": 0.18 }, ... },\
>   "\_\_total": { "currency": "USD", "n\_visitors": { "value": 52763, "pct\_change": 0.12 }, ... }\
> }\
> \`\`\`\
> \
> Each segment object contains \`currency\` (string) and metric fields. Each metric field is an object with \`value\` (number) and \`pct\_change\` (number) representing the percent change versus the comparison period. In audience view, per-segment metrics also include \`pct\_impact\_to\_total\_change\` (number), and the \`\_\_total\` segment additionally includes \`impact\_from\_visitor\_mix\_shift\` (number).\
> \
> \### Metric Availability by Feature\
> \
> \- \`performance\` returns this KPI subset: \`n\_visitors\`, \`conversion\_rate\`, \`n\_orders\`, \`aov\`, \`net\_revenue\`, \`gross\_profit\`, \`gross\_profit\_per\_visitor\`, \`net\_revenue\_per\_visitor\`, \`gross\_margin\_pct\`, \`average\_discount\`, \`pct\_revenue\_with\_cogs\`.\
> \- \`order\` returns this subset: \`aov\`, \`n\_visitors\`, \`n\_orders\`, \`median\_order\_value\`, \`average\_units\_per\_order\`, \`pct\_orders\_with\_free\_shipping\`, \`net\_shipping\_revenue\_per\_order\`.\
> \- \`conversion\` returns this subset: \`viewed\_collection\_page\_rate\`, \`viewed\_product\_page\_rate\`, \`add\_to\_cart\_rate\`, \`checkout\_begin\_rate\`, \`conversion\_rate\`, \`bounce\_rate\`, \`abandoned\_cart\_rate\`, \`abandoned\_checkout\_rate\`.\
> \- \`audience\` returns per-segment metrics plus a \`\_\_total\` key:\
>   \`n\_sessions\`, \`n\_visitors\`, \`n\_orders\`, \`gross\_revenue\`, \`net\_revenue\`, \`order\_cogs\`, \`conversion\_rate\`, \`aov\`, \`net\_revenue\_per\_visitor\`, \`shipping\_cost\`, \`transaction\_fees\`, \`tax\`, \`gross\_profit\`, \`gross\_profit\_per\_visitor\`, \`oli\_net\_product\_revenue\_with\_cogs\`, \`oli\_net\_product\_revenue\`, \`pct\_revenue\_with\_cogs\`.

````json
{"openapi":"3.1.0","info":{"title":"Intelligems External API v25-10-beta","version":"v25-10-beta"},"tags":[{"name":"Fetch Sitewide Analytics"}],"servers":[{"url":"https://api.intelligems.io","description":"Production"}],"security":[{"intelligems_access_token":[]}],"components":{"securitySchemes":{"intelligems_access_token":{"type":"apiKey","in":"header","name":"intelligems-access-token","description":"Intelligems external API access token."}}},"paths":{"/v25-10-beta/analytics/sitewide/snapshot":{"post":{"tags":["Fetch Sitewide Analytics"],"description":"Retrieve sitewide snapshot metrics for a time window.\n\nThe optional `feature` parameter is an object, not a string enum.\n\nUse `{ \"name\": \"performance\" }` for the core KPI subset, `{ \"name\": \"audience\", \"audience\": \"device_type\" }` for audience snapshots, `{ \"name\": \"order\" }` for order-focused snapshot metrics, or `{ \"name\": \"conversion\" }` for conversion funnel snapshot metrics. Omitting `feature` entirely returns the full sitewide metric set.\n\n### Response Structure\n\nThe response is a JSON object keyed by segment name, **not** a flat object with top-level metric fields.\n\nWhen no audience feature is specified (or `feature.name` is `\"performance\"`, `\"order\"`, or `\"conversion\"`), the response contains a single `\"All\"` key:\n\n```json\n{\n  \"All\": {\n    \"currency\": \"USD\",\n    \"n_visitors\": { \"value\": 52763, \"pct_change\": 0.12 },\n    \"conversion_rate\": { \"value\": 0.034, \"pct_change\": -0.05 },\n    ...\n  }\n}\n```\n\nWhen `feature.name` is `\"audience\"`, the response contains one key per audience segment plus a `\"__total\"` key:\n\n```json\n{\n  \"Desktop\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 30000, \"pct_change\": 0.08 }, ... },\n  \"Mobile\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 22763, \"pct_change\": 0.18 }, ... },\n  \"__total\": { \"currency\": \"USD\", \"n_visitors\": { \"value\": 52763, \"pct_change\": 0.12 }, ... }\n}\n```\n\nEach segment object contains `currency` (string) and metric fields. Each metric field is an object with `value` (number) and `pct_change` (number) representing the percent change versus the comparison period. In audience view, per-segment metrics also include `pct_impact_to_total_change` (number), and the `__total` segment additionally includes `impact_from_visitor_mix_shift` (number).\n\n### Metric Availability by Feature\n\n- `performance` returns this KPI subset: `n_visitors`, `conversion_rate`, `n_orders`, `aov`, `net_revenue`, `gross_profit`, `gross_profit_per_visitor`, `net_revenue_per_visitor`, `gross_margin_pct`, `average_discount`, `pct_revenue_with_cogs`.\n- `order` returns this subset: `aov`, `n_visitors`, `n_orders`, `median_order_value`, `average_units_per_order`, `pct_orders_with_free_shipping`, `net_shipping_revenue_per_order`.\n- `conversion` returns this subset: `viewed_collection_page_rate`, `viewed_product_page_rate`, `add_to_cart_rate`, `checkout_begin_rate`, `conversion_rate`, `bounce_rate`, `abandoned_cart_rate`, `abandoned_checkout_rate`.\n- `audience` returns per-segment metrics plus a `__total` key:\n  `n_sessions`, `n_visitors`, `n_orders`, `gross_revenue`, `net_revenue`, `order_cogs`, `conversion_rate`, `aov`, `net_revenue_per_visitor`, `shipping_cost`, `transaction_fees`, `tax`, `gross_profit`, `gross_profit_per_visitor`, `oli_net_product_revenue_with_cogs`, `oli_net_product_revenue`, `pct_revenue_with_cogs`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"description":"Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"end":{"description":"End of analysis period as an ISO 8601 datetime string. Defaults to now.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"filters":{"description":"Optional analytics filters object. See the Filters Reference for available filter fields.","type":"object","properties":{"deviceType":{"description":"Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.","anyOf":[{"type":"string","enum":["any","mobile","desktop"]},{"type":"null"}]},"visitorType":{"description":"Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.","anyOf":[{"type":"string","enum":["any","new","returning"]},{"type":"null"}]},"sourceSitesOrChannels":{"description":"Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.","type":"array","items":{"type":"string","enum":["Referral","All Social","Organic Social","Paid Social","Organic Search","Paid Search","Paid Shopping","Email","Google","Facebook","Instagram","Linktree","TikTok","Twitter","Direct","SMS","Other","Meta","Link Tree","Wunderkind Text","Youtube","any"]}},"landingPage":{"description":"Filter by landing page URL path. Object with: landingPageUrlPath (string|null — the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).","anyOf":[{"type":"object","properties":{"landingPageUrlPath":{"anyOf":[{"type":"string"},{"type":"null"}]},"landingPageUrlPathFilterType":{"anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]},{"type":"null"}]}},"required":["landingPageUrlPath","landingPageUrlPathFilterType"]},{"type":"null"}]},"landingPageFilters":{"description":"Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against — omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.","type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"filterType":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]}},"required":["filterType"]}},"landingPageFiltersOperator":{"description":"How multiple items in landingPageFilters are combined. 'or' (default) — session matches if any filter item matches. 'and' — session must match every filter item.","type":"string","enum":["or","and"]},"countryCodes":{"description":"Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.","type":"array","items":{"type":"string"}},"maxZScore":{"description":"Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.","anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"landingPageTypes":{"description":"Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.","type":"array","items":{"type":"string","enum":["PDP","Collection","Content","Blog","Homepage","Search","Cart","Other"]}},"allOrders":{"description":"Whether to include all orders or only matched orders.","type":"boolean"}}},"feature":{"description":"Optional feature selector object. Omit it or use `{ \"name\": \"performance\" }` for sitewide KPI snapshots, `{ \"name\": \"audience\", \"audience\": \"device_type\" }` for audience segment snapshots, `{ \"name\": \"order\" }` for order-focused metrics, or `{ \"name\": \"conversion\" }` for conversion funnel metrics.","oneOf":[{"type":"object","properties":{"name":{"type":"string","const":"performance"}},"required":["name"]},{"type":"object","properties":{"name":{"type":"string","const":"audience"},"audience":{"type":"string","enum":["device_type","visitor_type","source_channel","source_site","country_code","landing_page_full_path"],"description":"Optional audience breakdown dimension. When provided, returns per-segment snapshot instead of site-level KPIs. Supported values: device_type, visitor_type, source_channel, source_site, country_code, landing_page_full_path."}},"required":["name","audience"]},{"type":"object","properties":{"name":{"type":"string","const":"order"}},"required":["name"]},{"type":"object","properties":{"name":{"type":"string","const":"conversion"}},"required":["name"]}],"type":"object"}}}}}},"responses":{"200":{"description":"OK","headers":{"access-control-allow-origin":{"schema":{"type":"string"},"description":"CORS allow-origin header."},"access-control-allow-credentials":{"schema":{"type":"string"},"description":"CORS allow-credentials header."},"content-type":{"schema":{"type":"string"},"description":"Response content type."},"Timing-Allow-Origin":{"schema":{"type":"string"},"description":"Allowed origin for Timing headers."}},"content":{"application/json":{"schema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"currency":{"description":"ISO 4217 currency code for monetary values (e.g. 'USD').","type":"string"},"n_sessions":{"description":"Total number of sessions during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"n_visitors":{"description":"Total number of unique visitors during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"n_orders":{"description":"Total number of orders during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"gross_revenue":{"description":"Total gross revenue before discounts and returns.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"net_revenue":{"description":"Total net revenue during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"order_cogs":{"description":"Total cost of goods sold for all orders.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"lost_net_revenue":{"description":"Net revenue lost from returns and cancellations during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"discounts":{"description":"Total discount amount applied across all orders.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"average_discount":{"description":"Average discount rate during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"conversion_rate":{"description":"Overall site conversion rate during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"aov":{"description":"Average order value during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"net_revenue_per_visitor":{"description":"Average net revenue per visitor during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"discount_per_unit":{"description":"Average discount amount per unit sold.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"shipping_cost":{"description":"Total shipping cost across all orders.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"transaction_fees":{"description":"Total transaction/payment processing fees.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"tax":{"description":"Total tax collected across all orders.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"gross_profit":{"description":"Total gross profit during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"gross_margin_pct":{"description":"Gross margin as a percentage of net revenue.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"gross_profit_per_visitor":{"description":"Average gross profit per visitor during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"oli_net_product_revenue_with_cogs":{"description":"Net product revenue for line items that have cost of goods data.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"oli_net_product_revenue":{"description":"Net product revenue at the order line item level.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"median_order_value":{"description":"Median order value during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"average_units_per_order":{"description":"Average number of units per order.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"pct_orders_with_free_shipping":{"description":"Percentage of orders with free shipping during the period.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"net_shipping_revenue_per_order":{"description":"Average net shipping revenue collected per order.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"pct_revenue_with_cogs":{"description":"Percentage of revenue from products that have cost of goods data.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"viewed_collection_page_rate":{"description":"Percentage of sessions that viewed a collection page.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"viewed_product_page_rate":{"description":"Percentage of sessions that viewed a product detail page.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"add_to_cart_rate":{"description":"Percentage of sessions that added at least one product to cart.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"checkout_begin_rate":{"description":"Percentage of sessions that started the checkout flow.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"bounce_rate":{"description":"Percentage of sessions that ended without navigating to a second page.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"abandoned_cart_rate":{"description":"Percentage of sessions that added to cart but did not convert.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"abandoned_checkout_rate":{"description":"Percentage of sessions that started checkout but did not convert.","type":"object","properties":{"pct_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"pct_impact_to_total_change":{"description":"For audience snapshots, each segment's percent contribution to the metric's total percent change over the comparison period.","anyOf":[{"type":"number"},{"type":"null"}]},"impact_from_visitor_mix_shift":{"description":"For audience ratio metrics on the __total row, the percent change impact attributed to shifts in visitor mix between segments.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false}},"additionalProperties":false}}}}}}}}}}
````

## POST /v25-10-beta/analytics/sitewide/timeseries

>

```json
{"openapi":"3.1.0","info":{"title":"Intelligems External API v25-10-beta","version":"v25-10-beta"},"tags":[{"name":"Fetch Sitewide Analytics"}],"servers":[{"url":"https://api.intelligems.io","description":"Production"}],"security":[{"intelligems_access_token":[]}],"components":{"securitySchemes":{"intelligems_access_token":{"type":"apiKey","in":"header","name":"intelligems-access-token","description":"Intelligems external API access token."}}},"paths":{"/v25-10-beta/analytics/sitewide/timeseries":{"post":{"tags":["Fetch Sitewide Analytics"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"description":"Start of analysis period as an ISO 8601 datetime string (e.g. '2025-01-01T00:00:00.000-05:00'). Defaults to 30 days ago.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"end":{"description":"End of analysis period as an ISO 8601 datetime string. Defaults to now.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"feature":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","const":"performance"}},"required":["name"]},{"type":"object","properties":{"name":{"type":"string","const":"audience"},"audience":{"type":"string","enum":["device_type","visitor_type","source_channel","source_site","country_code","landing_page_full_path"],"description":"Optional audience breakdown dimension. When provided, returns per-segment snapshot instead of site-level KPIs. Supported values: device_type, visitor_type, source_channel, source_site, country_code, landing_page_full_path."}},"required":["name","audience"]},{"type":"object","properties":{"name":{"type":"string","const":"order"}},"required":["name"]},{"type":"object","properties":{"name":{"type":"string","const":"conversion"}},"required":["name"]}],"type":"object"},"granularity":{"default":"week","description":"Time bucket granularity. Supported values: day, week, month. Defaults to week.","type":"string","enum":["day","week","month"]},"filters":{"description":"Optional analytics filters object. See the Filters Reference for available filter fields.","type":"object","properties":{"deviceType":{"description":"Filter by device type. Options: 'any' (disables filter), 'mobile', 'desktop'. Omit or null to include all devices.","anyOf":[{"type":"string","enum":["any","mobile","desktop"]},{"type":"null"}]},"visitorType":{"description":"Filter by visitor type. Options: 'any' (disables filter), 'new', 'returning'. Omit or null to include all visitors.","anyOf":[{"type":"string","enum":["any","new","returning"]},{"type":"null"}]},"sourceSitesOrChannels":{"description":"Filter by traffic source channels. Array of channel names: 'Referral', 'All Social', 'Organic Social', 'Paid Social', 'Organic Search', 'Paid Search', 'Paid Shopping', 'Email', 'Google', 'Facebook', 'Instagram', 'Linktree', 'TikTok', 'Twitter', 'Direct', 'SMS', 'Meta', 'Link Tree', 'Wunderkind Text', 'Youtube', 'Other', 'any'. Omit or pass empty array for all channels.","type":"array","items":{"type":"string","enum":["Referral","All Social","Organic Social","Paid Social","Organic Search","Paid Search","Paid Shopping","Email","Google","Facebook","Instagram","Linktree","TikTok","Twitter","Direct","SMS","Other","Meta","Link Tree","Wunderkind Text","Youtube","any"]}},"landingPage":{"description":"Filter by landing page URL path. Object with: landingPageUrlPath (string|null — the path to match), landingPageUrlPathFilterType (match operator|null: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull'). For 'isNull'/'isNotNull' operators, set landingPageUrlPath to null. Note: 'regex' is NOT supported here (unlike urlParam).","anyOf":[{"type":"object","properties":{"landingPageUrlPath":{"anyOf":[{"type":"string"},{"type":"null"}]},"landingPageUrlPathFilterType":{"anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]},{"type":"null"}]}},"required":["landingPageUrlPath","landingPageUrlPathFilterType"]},{"type":"null"}]},"landingPageFilters":{"description":"Filter by landing page URL path with multi-value support. Array of filter items, each with: filterType (match operator: 'equals', 'contains', 'startsWith', 'endsWith', 'doesNotEqual', 'doesNotContain', 'doesNotStartWith', 'doesNotEndWith', 'isNull', 'isNotNull') and values (array of strings to match against — omit for 'isNull'/'isNotNull'). Multiple values within a single item are OR'd. How items in the array are combined is controlled by landingPageFiltersOperator.","type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"filterType":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull"]}},"required":["filterType"]}},"landingPageFiltersOperator":{"description":"How multiple items in landingPageFilters are combined. 'or' (default) — session matches if any filter item matches. 'and' — session must match every filter item.","type":"string","enum":["or","and"]},"countryCodes":{"description":"Filter by ISO 3166-1 alpha-2 country codes (e.g. ['US', 'GB', 'CA']). Omit or pass empty array for all countries.","type":"array","items":{"type":"string"}},"maxZScore":{"description":"Maximum Z-score threshold for outlier filtering on order revenue. Visitors with orders whose Z-score exceeds this value are excluded. Accepts number or numeric string. Null or omit to disable outlier filtering.","anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"landingPageTypes":{"description":"Filter sessions by landing page types. An array of values from: 'PDP', 'Collection', 'Content', 'Blog', 'Homepage', 'Search', 'Cart', 'Other'. Omit or null to include all landing page types.","type":"array","items":{"type":"string","enum":["PDP","Collection","Content","Blog","Homepage","Search","Cart","Other"]}},"allOrders":{"description":"Whether to include all orders or only matched orders.","type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","headers":{"access-control-allow-origin":{"schema":{"type":"string"},"description":"CORS allow-origin header."},"access-control-allow-credentials":{"schema":{"type":"string"},"description":"CORS allow-credentials header."},"content-type":{"schema":{"type":"string"},"description":"Response content type."},"Timing-Allow-Origin":{"schema":{"type":"string"},"description":"Allowed origin for Timing headers."}},"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"ISO 4217 currency code for monetary values (e.g. 'USD')."},"granularity":{"type":"string","enum":["day","week","month"],"description":"The granularity used for time bucketing."},"segments":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dt":{"type":"string"}},"required":["dt"],"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]}}},"summary":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]}}},"required":["data"],"additionalProperties":false},"description":"Time series data keyed by segment name. Contains 'All' for performance/order requests, or per-segment keys when `feature.name` is `audience`."}},"required":["currency","granularity","segments"],"additionalProperties":false}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.intelligems.io/developer-resources/external-api/fetch-sitewide-analytics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.