Analytics API

Overview

The Analytics API is intended for backend data retrieval, reporting, and insight-driven workflows. Use this group when you need aggregate or query-oriented identity data rather than user-facing authentication or account-management flows.

This group is best understood as a data-access surface for analytics and insight generation.

What this API group covers

The current Analytics API group includes:

• Identity
• Custom Objects
• Insights

These sections help you query identity records, retrieve analytics-oriented custom object data, and run insight-style operations over user information.

Available sections

Identity

Identity-focused retrieval and reporting endpoints for user-profile data access in analytics-oriented contexts.

Custom Objects

Endpoints for querying custom object data used in reporting, segmentation, or data-processing workflows.

Insights

Endpoints that support insight-style querying and user-profile analysis use cases.

Common workflows

Typical uses for this group include:

• retrieving identity data for analytics or reporting
• querying custom objects for backend analysis
• generating user insight or segmentation inputs
• building dashboards, exports, or operational analysis workflows

When to start here

Start with the Analytics API when:

• your goal is reporting or analysis rather than authentication
• you need insight-oriented identity retrieval
• you need analytics-style access to custom object data
• you are building backend data pipelines or internal reporting tools

If you are modifying user accounts or handling user-facing auth flows, use the Authentication API or Account API instead.

Next steps

• Review the Authorization page for this group before integrating backend retrieval jobs
• Start with Identity for user data analysis use cases
• Use Custom Objects when your reporting depends on flexible structured records
• Use Insights for analytics-specific profile query flows