Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Contentstack Analytics API

The Contentstack Analytics API provides access to usage and performance metrics for CMS, Launch, and Automate products within a Contentstack organization. Developers can retrieve analytics data programmatically to build custom dashboards, monitor content delivery performance, and track platform usage against plan limits.

Contentstack Analytics API is one of 45 APIs that contentstack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, Metrics, Monitoring, and Reporting. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 3 base URLs: https://api.contentstack.io, https://eu-api.contentstack.com, https://au-api.contentstack.com.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.contentstack.io
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Contentstack Analytics API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as authtoken (authtokenAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token (M2M) with analytics access.
  • authtokenAuth — Contentstack user authtoken. Only organization Owners and Admins can access analytics.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Analytics 1

Analytics endpoints provide usage metrics for Launch projects such as cache revalidation quota consumption.

GET
/organizations/cache-revalidation-usage
Get cache revalidation usage
getCacheRevalidationUsage → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CacheUsage (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
Standard error response.
2 properties
CacheUsage
object
Cache revalidation usage metrics for the organization.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

contentstack-analytics-api-openapi.yml Raw ↑

Other APIs contentstack publishes across the network.

Contentstack GraphQL Content Delivery API
Contentstack Image Delivery API
Contentstack Knowledge Vault API
Contentstack Generative AI API
contentstack Accounts API
contentstack Assets API
contentstack Attributes API
contentstack Audiences API
contentstack Audit Logs API
contentstack Automations API
contentstack Brand Kits API
contentstack Cache Analytics API