Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe 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
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • 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. Lytics API
  4. Reports

Reports

markdownView as Markdown

Create and manage reports.

Get Reports

GEThttps://api.lytics.io/v2/report

Get a list of all Reports for the account

Sample Response
Status|200 OK
123456789101112131415161718192021
{
  "_meta": {},
  "data": [
    {
      "components": [
        {
          "config": null,
          "description": "string",
          "id": "string",
          "name": "string",
          "type": "size"
        }
      ],
      "description": "string",
      "label": "string",
      "user_id": "string"
    }
  ],
  "request_id": "string",
  "status": 0
}

Create a Report

POSThttps://api.lytics.io/v2/report

Create a new Report

Sample Request
1234567891011121314
{
  "components": [
    {
      "config": null,
      "description": "string",
      "id": "string",
      "name": "string",
      "type": "size"
    }
  ],
  "description": "string",
  "label": "string",
  "user_id": "string"
}
Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Get a Report

GEThttps://api.lytics.io/v2/report/{id}

Get a Report by ID

Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Update Report

PUThttps://api.lytics.io/v2/report/{id}

Update a Report's label or description

Sample Request
1234567891011121314
{
  "components": [
    {
      "config": null,
      "description": "string",
      "id": "string",
      "name": "string",
      "type": "size"
    }
  ],
  "description": "string",
  "label": "string",
  "user_id": "string"
}
Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Delete a Report

DELETEhttps://api.lytics.io/v2/report/{id}

Delete a Report by ID

Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Create a new Report Component

POSThttps://api.lytics.io/v2/report/{id}/component

Add a new Report Component to the Report. If the component already exists, it will be updated.

To create a new Component, you will need to specify the type, name, and config fields.

Depending on the Component type, you may need to specify additional fields in the config object.

For size components, you will need to specify the segment_ids field ([]string) in the config object.

For composition components, you will need to specify the segment_ids ([]string) field and a field (string) from the user schema in the config object.

For overflow components, you will need to specify the segment_ids ([]string) field in the config object.

For dataflow components, you will need to specify the segment_ids ([]string) field in the config object, as well as show_providers, show_streams, and show_destinations (boolean) options.

Sample Request
1234567
{
  "config": null,
  "description": "string",
  "id": "string",
  "name": "string",
  "type": "size"
}
Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Update a Report component

PUThttps://api.lytics.io/v2/report/{id}/component/{componentid}

Update a Report Component by ID

Sample Request
1234567
{
  "config": null,
  "description": "string",
  "id": "string",
  "name": "string",
  "type": "size"
}
Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Delete a Report Component

DELETEhttps://api.lytics.io/v2/report/{id}/component/{componentid}

Delete a Report Component by ID

Sample Response
Status|200 OK
12345678910111213141516171819
{
  "_meta": {},
  "data": {
    "components": [
      {
        "config": null,
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "size"
      }
    ],
    "description": "string",
    "label": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

componentsoptionalobject[]

List of components that make up the report

components[].configoptionalany

The configuration for the component. The structure of this object is dependent on the type of component. See the top of the page for more information.

components[].descriptionoptionalstring

An optional description of the component

components[].idoptionalstring
components[].namerequiredstring

The name of the component to be used in the Report.

components[].typerequiredstring

The type of component to be used in the Report.

One of: size, composition, overlap, dataflow

descriptionoptionalstring

An optional description of the Report

labelrequiredstring

A label for the Report. This is how the report will be identified in the UI.

user_idoptionalstring

The user ID that created or updated the report

Hide Parameters

URL Parameters

idrequiredstring

The report ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The report ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

componentsoptionalobject[]

List of components that make up the report

components[].configoptionalany

The configuration for the component. The structure of this object is dependent on the type of component. See the top of the page for more information.

components[].descriptionoptionalstring

An optional description of the component

components[].idoptionalstring
components[].namerequiredstring

The name of the component to be used in the Report.

components[].typerequiredstring

The type of component to be used in the Report.

One of: size, composition, overlap, dataflow

descriptionoptionalstring

An optional description of the Report

labelrequiredstring

A label for the Report. This is how the report will be identified in the UI.

user_idoptionalstring

The user ID that created or updated the report

Hide Parameters

URL Parameters

idrequiredstring

The report ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The report ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

configoptionalany

The configuration for the component. The structure of this object is dependent on the type of component. See the top of the page for more information.

descriptionoptionalstring

An optional description of the component

idoptionalstring
namerequiredstring

The name of the component to be used in the Report.

typerequiredstring

The type of component to be used in the Report.

One of: size, composition, overlap, dataflow

Hide Parameters

URL Parameters

idrequiredstring

The report ID

componentidrequiredstring

The component ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

configoptionalany

The configuration for the component. The structure of this object is dependent on the type of component. See the top of the page for more information.

descriptionoptionalstring

An optional description of the component

idoptionalstring
namerequiredstring

The name of the component to be used in the Report.

typerequiredstring

The type of component to be used in the Report.

One of: size, composition, overlap, dataflow

Hide Parameters

URL Parameters

idrequiredstring

The report ID

componentidrequiredstring

The component ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring