Fetch Sitewide Analytics

post

Authorizations

intelligems-access-tokenstringRequired

Intelligems external API access token.

Body

startstring · date-timeOptional

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.

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)))$

endstring · date-timeOptional

End of analysis period as an ISO 8601 datetime string. Defaults to now.

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)))$

Responses

200

application/json

post

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

POST /v25-10-beta/analytics/sitewide/order-distribution HTTP/1.1
intelligems-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 969

{
  "start": "2026-03-31T01:23:57.795Z",
  "end": "2026-03-31T01:23:57.795Z",
  "filters": {
    "deviceType": "any",
    "visitorType": "any",
    "sourceSitesOrChannels": [
      "Referral"
    ],
    "urlParam": {
      "queryParam": "text",
      "queryParamValue": "text",
      "queryParamFilterType": "equals"
    },
    "landingPage": {
      "landingPageUrlPath": "text",
      "landingPageUrlPathFilterType": "equals"
    },
    "userBehavior": {
      "viewedCheckout": true,
      "addedToCart": true,
      "viewedProductPage": true,
      "viewedCollectionPage": true
    },
    "countryCodes": [
      "text"
    ],
    "maxZScore": 1,
    "triggeredCustomEvents": [
      "text"
    ],
    "customEventsFilterType": "any",
    "reachedCheckoutStage": "started",
    "conversionFunnel": {
      "abandonedCart": true,
      "abandonedCheckout": true,
      "addedToCart": true,
      "bounced": true,
      "converted": true,
      "exitedBeforeAtc": true,
      "startedCheckout": true,
      "viewedCollectionPage": true,
      "viewedProductPage": true,
      "landingPageType": "Blog",
      "secondPageType": "Blog"
    },
    "minNetRevenue": 1,
    "maxNetRevenue": 1,
    "minShippingRevenue": 1,
    "maxShippingRevenue": 1,
    "shippingMethods": [
      "text"
    ],
    "allOrders": true
  }
}

200

{
  "currency": "text",
  "orderValueDistribution": {
    "kernal_density_estimate": [
      {
        "x": 1,
        "current_period": 1,
        "previous_period": 1
      }
    ],
    "cumulative_distribution_function": [
      {
        "x": 1,
        "current_period": 1,
        "previous_period": 1
      }
    ]
  },
  "orderBreakdown": [
    {
      "dt": "text",
      "unit_quantity": 1,
      "n_orders": {
        "value": 1
      },
      "net_revenue": {
        "value": 1
      },
      "gross_profit": {
        "value": 1
      },
      "pct_orders_by_unit_quantity": {
        "value": 1
      },
      "pct_revenue_by_unit_quantity": {
        "value": 1
      },
      "pct_profit_by_unit_quantity": {
        "value": 1
      }
    }
  ]
}

post

Authorizations

intelligems-access-tokenstringRequired

Intelligems external API access token.

Body

startstring · date-timeOptional

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.

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)))$

endstring · date-timeOptional

End of analysis period as an ISO 8601 datetime string. Defaults to now.

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)))$

featureone ofOptional

Responses

200

application/json

post

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

POST /v25-10-beta/analytics/sitewide/snapshot HTTP/1.1
intelligems-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 995

{
  "start": "2026-03-31T01:23:57.795Z",
  "end": "2026-03-31T01:23:57.795Z",
  "filters": {
    "deviceType": "any",
    "visitorType": "any",
    "sourceSitesOrChannels": [
      "Referral"
    ],
    "urlParam": {
      "queryParam": "text",
      "queryParamValue": "text",
      "queryParamFilterType": "equals"
    },
    "landingPage": {
      "landingPageUrlPath": "text",
      "landingPageUrlPathFilterType": "equals"
    },
    "userBehavior": {
      "viewedCheckout": true,
      "addedToCart": true,
      "viewedProductPage": true,
      "viewedCollectionPage": true
    },
    "countryCodes": [
      "text"
    ],
    "maxZScore": 1,
    "triggeredCustomEvents": [
      "text"
    ],
    "customEventsFilterType": "any",
    "reachedCheckoutStage": "started",
    "conversionFunnel": {
      "abandonedCart": true,
      "abandonedCheckout": true,
      "addedToCart": true,
      "bounced": true,
      "converted": true,
      "exitedBeforeAtc": true,
      "startedCheckout": true,
      "viewedCollectionPage": true,
      "viewedProductPage": true,
      "landingPageType": "Blog",
      "secondPageType": "Blog"
    },
    "minNetRevenue": 1,
    "maxNetRevenue": 1,
    "minShippingRevenue": 1,
    "maxShippingRevenue": 1,
    "shippingMethods": [
      "text"
    ],
    "allOrders": true
  },
  "feature": {
    "name": "text"
  }
}

200

{
  "ANY_ADDITIONAL_PROPERTY": {
    "currency": "text",
    "n_sessions": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "n_visitors": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "n_orders": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "gross_revenue": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "net_revenue": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "order_cogs": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "lost_net_revenue": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "discounts": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "average_discount": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "conversion_rate": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "aov": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "net_revenue_per_visitor": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "discount_per_unit": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "shipping_cost": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "transaction_fees": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "tax": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "gross_profit": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "gross_margin_pct": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "gross_profit_per_visitor": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "oli_net_product_revenue_with_cogs": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "oli_net_product_revenue": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "median_order_value": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "average_units_per_order": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "pct_orders_with_free_shipping": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "net_shipping_revenue_per_order": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    },
    "pct_revenue_with_cogs": {
      "pct_change": 1,
      "value": 1,
      "pct_impact_to_total_change": 1
    }
  }
}

post

Authorizations

intelligems-access-tokenstringRequired

Intelligems external API access token.

Body

startstring · date-timeOptional

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.

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)))$

endstring · date-timeOptional

End of analysis period as an ISO 8601 datetime string. Defaults to now.

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)))$

featureone ofOptional

granularitystring · enumOptional

Time bucket granularity. Supported values: day, week, month. Defaults to week.

Default: weekPossible values:

Responses

200

application/json

post

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

POST /v25-10-beta/analytics/sitewide/timeseries HTTP/1.1
intelligems-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1016

{
  "start": "2026-03-31T01:23:57.795Z",
  "end": "2026-03-31T01:23:57.795Z",
  "feature": {
    "name": "text"
  },
  "granularity": "week",
  "filters": {
    "deviceType": "any",
    "visitorType": "any",
    "sourceSitesOrChannels": [
      "Referral"
    ],
    "urlParam": {
      "queryParam": "text",
      "queryParamValue": "text",
      "queryParamFilterType": "equals"
    },
    "landingPage": {
      "landingPageUrlPath": "text",
      "landingPageUrlPathFilterType": "equals"
    },
    "userBehavior": {
      "viewedCheckout": true,
      "addedToCart": true,
      "viewedProductPage": true,
      "viewedCollectionPage": true
    },
    "countryCodes": [
      "text"
    ],
    "maxZScore": 1,
    "triggeredCustomEvents": [
      "text"
    ],
    "customEventsFilterType": "any",
    "reachedCheckoutStage": "started",
    "conversionFunnel": {
      "abandonedCart": true,
      "abandonedCheckout": true,
      "addedToCart": true,
      "bounced": true,
      "converted": true,
      "exitedBeforeAtc": true,
      "startedCheckout": true,
      "viewedCollectionPage": true,
      "viewedProductPage": true,
      "landingPageType": "Blog",
      "secondPageType": "Blog"
    },
    "minNetRevenue": 1,
    "maxNetRevenue": 1,
    "minShippingRevenue": 1,
    "maxShippingRevenue": 1,
    "shippingMethods": [
      "text"
    ],
    "allOrders": true
  }
}

200

{
  "currency": "text",
  "granularity": "day",
  "segments": {
    "ANY_ADDITIONAL_PROPERTY": {
      "data": [
        {
          "dt": "text",
          "ANY_ADDITIONAL_PROPERTY": 1
        }
      ],
      "summary": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  }
}

PreviousPerform Experience Action NextAutomations & Guides

Last updated 1 hour ago