Get inspired at ContentCon Europe. See the agenda and register for free.
Get inspired at ContentCon Europe. See the agenda and register for free.
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Personalize Management API
  4. Experience Analytics

Experience Analytics

markdownView as Markdown

Experience Analytics refers to the process of collecting, analyzing, and interpreting data about user interactions to understand and improve the Personalize experiences. Analytics is only available for activated experiences. The following requests allow you to fetch the analytics of the specific experiences performance within a project.

Get Analytics Summary

GEThttps://personalize-api.contentstack.com/experiences/{uid}/analytics/summary

The Get Analytics Summary request fetches the analytics summary of a specific experience of a project. The summary gives you a count of impressions and conversions for a variant, along with its probability to be best in the given timeframe. The leading or winning variant information as determined by the analytics engine is also calculated and returned provided that sufficient data exists.

Please note that leading variant and conversion information is only available on A/B test experiences.

To configure the permissions for your application via OAuth, include the personalize:read or the personalize:manage scope.

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637
{
  "variants": [
    {
      "name": "Control",
      "shortUid": "0",
      "impressions": 2160,
      "conversions": [
        {
          "metric": "Click",
          "__type": "Primary",
          "count": 108
        }
      ],
      "probabilityToBeBest": 95
    },
    {
      "name": "Alternate Heading",
      "shortUid": "1",
      "impressions": 2161,
      "conversions": [
        {
          "metric": "Click",
          "__type": "Primary",
          "count": 72
        }
      ],
      "probabilityToBeBest": 5
    }
  ],
  "leadingVariant": {
    "status": "LEADING",
    "name": "Control",
    "shortUid": "0"
  },
  "refreshedAt": "2026-07-29T08:48:25.781Z",
  "experienceVersion": "6887777b3335554698867847"
}

Get Time-series Analytics

GEThttps://personalize-api.contentstack.com/experiences/{uid}/analytics/time-series

The Get Time-series Analytics request fetches the time-series analytics of a specific experience of a project. The response contains hourly impressions and conversions for the specified time-frame. The duration for each interval is specified in the ISO-8601 interval format.

To configure the permissions for your application via OAuth, include the personalize:read or personalize:manage scope.

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
[
  {
    "interval": "2024-09-21T10:47:56.660Z/PT1H",
    "variants": [
      {
        "shortUid": "0",
        "impressions": 1080,
        "conversions": [
          {
            "metric": "Click",
            "count": 54,
            "__type": "Primary"
          }
        ]
      },
      {
        "shortUid": "1",
        "impressions": 1081,
        "conversions": [
          {
            "metric": "Click",
            "count": 36,
            "__type": "Primary"
          }
        ]
      }
    ],
    "experienceVersion": "6887777b3335554698867847"
  },
  {
    "interval": "2024-09-21T11:47:56.660Z/PT1H",
    "variants": [
      {
        "shortUid": "0",
        "impressions": 1080,
        "conversions": [
          {
            "metric": "Click",
            "count": 54,
            "__type": "Primary"
          }
        ]
      },
      {
        "shortUid": "1",
        "impressions": 1081,
        "conversions": [
          {
            "metric": "Click",
            "count": 36,
            "__type": "Primary"
          }
        ]
      }
    ],
    "experienceVersion": "6887777b3335554698867847"
  }
]
Hide Parameters

URL Parameters

uidrequiredstring

Enter the Experience UID to fetch analytics for

Query Parameters

tooptionalstring

The “to” parameter allows you to specify the end date for the analytics summary of the experiences. The timestamp is provided in the ISO-8601 format. If not specified, analytics leading upto the present date is returned.

fromoptionalstring

The “from” parameter allows you to specify the start date for the analytics summary of the experiences. The timestamp is provided in the ISO-8601 format. If not specified, analytics from the beginning of the experiment is returned.

versionrequiredstring

The analytics is filtered to fetch a specific version. Pass the version uid here. This is a required query parameter.

Headers

authorizationoptionalstring

Enter your OAuth token here. Read more: https://www.contentstack.com/docs/developers/developer-hub/contentstack-oauth

authtokenoptionalstring

Enter your authtoken here. Read more: https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens#authentication-tokens-authtokens

x-project-uidrequiredstring

Hide Parameters

URL Parameters

uidrequiredstring

Enter the Experience UID to fetch analytics for

Query Parameters

tooptionalstring

The “to” parameter allows you to specify the end date for the analytics summary of the experiences. The timestamp is provided in the ISO-8601 format. If not specified, analytics leading upto the present date is returned.

fromoptionalstring

The “from” parameter allows you to specify the start date for the analytics summary of the experiences. The timestamp is provided in the ISO-8601 format. If not specified, analytics from the beginning of the experiment is returned.

metricoptionalstring

The metric parameter allows you to fetch the time-series analytics for a specific event metric configured in the A/B test. Filtering by metric only works for an A/B test.

versionrequiredstring

The analytics is filtered to fetch a specific version. Pass the version uid here. This is a required query parameter.

Headers

authorizationoptionalstring

Enter your OAuth token here. Read more: https://www.contentstack.com/docs/developers/developer-hub/contentstack-oauth

authtokenoptionalstring

Enter your authtoken here. Read more: https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens#authentication-tokens-authtokens

x-project-uidrequiredstring