Analytics Suite — API Reference

Analyze the behaviors of Profiles in no time.

82 endpoints across 11 tags.

Analytics: Aggregates

• POST /analytics/analytics/definitions-manager/aggregates/{aggregateId}/client/{clientId}/calculate/histogram — Calculate aggregate for profile with period conditions
• POST /analytics/{namespace}/aggregates/preview/by/{identifierType} — Get aggregate preview
• POST /analytics/{namespace}/aggregates/visible-for-client/by/{identifierType} — Get aggregates for profile card
• POST /analytics/{namespace}/aggregates/{aggregateId}/calculate/by/{identifierType} — Calculate aggregate for profile
• GET /analytics/{namespace}/aggregates — List aggregates
• POST /analytics/{namespace}/aggregates — Create aggregate
• GET /analytics/{namespace}/aggregates/{aggregateId} — Get aggregate details
• PUT /analytics/{namespace}/aggregates/{aggregateId} — Update aggregate
• DELETE /analytics/{namespace}/aggregates/{aggregateId} — Delete aggregate

Analytics: Expressions

• POST /analytics/{namespace}/expressions/visible-for-client/by/{identifierType} — Get expressions for profile card
• POST /analytics/{namespace}/expressions/{expressionId}/calculate/by/{identifierType} — Calculate expression for profile
• GET /analytics/{namespace}/expressions — List expressions
• POST /analytics/{namespace}/expressions — Create expression
• GET /analytics/{namespace}/expressions/{expressionId} — Get expression details
• PUT /analytics/{namespace}/expressions/{expressionId} — Update expression
• DELETE /analytics/{namespace}/expressions/{expressionId} — Delete expression
• POST /analytics/{namespace}/expressions/preview/by/{identifierType} — Get expression preview

Analytics: Funnels

• POST /analytics/analytics/v2/funnels/preview — Preview funnel calculation
• POST /analytics/analytics/v2/funnels/{funnelId}/recalculate/override — Recalculate funnel with parameter override
• GET /analytics/{namespace}/funnels — List funnels
• POST /analytics/{namespace}/funnels — Create a funnel
• GET /analytics/{namespace}/funnels/{funnelId} — Get funnel details
• PUT /analytics/{namespace}/funnels/{funnelId} — Update funnel
• DELETE /analytics/{namespace}/funnels/{funnelId} — Delete funnel

Analytics: Histograms

• GET /analytics/{namespace}/histograms — List histograms
• POST /analytics/{namespace}/histograms — Create histogram
• GET /analytics/{namespace}/histograms/{histogramId} — Get histogram details
• PUT /analytics/{namespace}/histograms/{histogramId} — Update histogram analysis
• DELETE /analytics/{namespace}/histograms/{histogramId} — Delete histogram
• POST /analytics/analytics/v2/metrics/histograms/{histogramId}/recalculate/override — Calculate histogram with parameter override
• POST /analytics/analytics/v2/metrics/histograms/preview — Preview histogram

Analytics: Metrics

• GET /analytics/{namespace}/metrics — List metrics
• POST /analytics/{namespace}/metrics — Create metric analysis
• GET /analytics/{namespace}/metrics/{metricId} — Get metric details
• PUT /analytics/{namespace}/metrics/{metricId} — Update metric
• DELETE /analytics/{namespace}/metrics/{metricId} — Delete metric analysis
• POST /analytics/analytics/v3/metrics/preview — Preview metric
• POST /analytics/analytics/v3/metrics/{metricId}/recalculate/override — Calculate metric with parameter override
• POST /analytics/analytics/v3/metrics/{metricId}/recalculate — Calculate metric
• POST /analytics/analytics/v3/metrics/{metricId}/dynamic/value — Calculate dynamic metric
• GET /analytics/analytics/v3/metrics/histogram-metrics — Get metrics usable in histograms

AI: Metrics

• GET /metrics/metrics/v2/available — Check available metrics (recommendations)
• GET /metrics/metrics/v2/available-ids — Retrieve IDs of available metrics (recommendations)

Analytics: Reports

• POST /analytics/analytics/v4/reports/{reportId}/recalculate/override — Calculate report with override
• POST /analytics/analytics/v4/reports/{reportId}/recalculate — Recalculate report
• POST /analytics/analytics/v4/reports/preview — Preview report
• POST /analytics/analytics/v4/reports/preview-csv — Preview report as CSV
• GET /analytics/{namespace}/reports — List reports
• POST /analytics/{namespace}/reports — Create report analysis
• GET /analytics/{namespace}/reports/{reportId} — Get report analysis details
• PUT /analytics/{namespace}/reports/{reportId} — Update report analysis
• DELETE /analytics/{namespace}/reports/{reportId} — Delete report analysis

Analytics: Sankeys

• POST /analytics/analytics/v2/sankeys/preview — Preview Sankey analysis
• GET /analytics/{namespace}/sankeys — List Sankeys
• POST /analytics/{namespace}/sankeys — Create Sankey analysis
• GET /analytics/{namespace}/sankeys/{sankeyId} — Get Sankey details
• PUT /analytics/{namespace}/sankeys/{sankeyId} — Update Sankey
• DELETE /analytics/{namespace}/sankeys/{sankeyId} — Delete Sankey

Analytics: Segmentations

• POST /analytics/analytics/v2/segmentations/{segmentationId}/dynamic/value — Calculate dynamic segmentation
• POST /analytics/analytics/v2/segmentations/preview — Preview segmentation
• POST /analytics/analytics/v2/segmentations/preview/clients — Preview profiles in segmentation
• POST /analytics/profiles/segmentations/firstMatch/by/{identifierType} — Get first matching segmentation for profile from provided list
• GET /analytics/{namespace}/segmentations — List segmentations
• POST /analytics/{namespace}/segmentations — Create segmentation
• GET /analytics/{namespace}/segmentations/{segmentationId} — Get segmentation details
• PUT /analytics/{namespace}/segmentations/{segmentationId} — Update segmentation
• DELETE /analytics/{namespace}/segmentations/{segmentationId} — Delete segmentation
• POST /analytics/{namespace}/segmentations/visible-for-client/by/{identifierType} — Get segmentations for profile card
• POST /analytics/{namespace}/segmentations/check/by/{identifierType} — Check if profile in segmentations

Analytics: Trends

• GET /analytics/{namespace}/trends — List trends
• POST /analytics/{namespace}/trends — Create a trend
• GET /analytics/{namespace}/trends/{trendId} — Get trend details
• PUT /analytics/{namespace}/trends/{trendId} — Update trend
• DELETE /analytics/{namespace}/trends/{trendId} — Delete trend
• POST /analytics/analytics/v2/trends/{trendId}/recalculate/override — Calculate trend with parameter override
• POST /analytics/analytics/v2/trends/preview — Preview trend calculation

Analytics: Management

• POST /analytics/analytics/batch-delete — Delete multiple analyses
• GET /analytics/directories — List directories
• POST /analytics/directories — Create directory
• PATCH /analytics/directories/{directoryId} — Rename directory
• DELETE /analytics/directories/{directoryId} — Delete directory
• PATCH /analytics/directories/change/{analyticId} — Change Directory

Back to all API categories