Allegro REST API
Endpoints that use authenticated user tokens.
- Base URL
- https://{tenant}.allegrocdp.com/api/v1
- Auth
- Bearer token
- Endpoints
- 73 in 29 groups
- Version
- OpenAPI 3.1
Authentication
Requests authenticate with an organization API key sent as a bearer token. Admins create keys in the dashboard and choose the scopes each one carries.
Create an API keyhttp
GET /api/v1/analytics/schemaHost: {tenant}.allegrocdp.comAuthorization: Bearer <your-key>
Endpoint groups
- Analytics18 endpointsGet Analytics Schema · Explore Events · List Analytics Events · Run Analytics Query · Get Realtime Analytics · Get Traffic Analytics · Get Time on Site Analytics · Get Content Gate Analytics · Get Sign-up Analytics · Get Login Analytics · Get Purchase Analytics · Get Event Counts · Get Story Analytics · Get Reader Analytics · List Analytics Reports · Create Analytics Report · Get Analytics Report · Run Analytics Report
- AnalyticsSchema1 endpointGet Analytics Schema
- AnalyticsExplore1 endpointExplore Events
- AnalyticsEventStream1 endpointList Analytics Events
- AnalyticsQuery1 endpointRun Analytics Query
- AnalyticsRealtime1 endpointGet Realtime Analytics
- AnalyticsView7 endpointsGet Traffic Analytics · Get Time on Site Analytics · Get Content Gate Analytics · Get Sign-up Analytics · Get Login Analytics · Get Purchase Analytics · Get Event Counts
- AnalyticsContent1 endpointGet Story Analytics
- AnalyticsReader1 endpointGet Reader Analytics
- AnalyticsReport4 endpointsList Analytics Reports · Create Analytics Report · Get Analytics Report · Run Analytics Report
- AudienceDeviceSession1 endpointList Audience Device Sessions
- AudienceMember7 endpointsList Audience Members · Create Audience Member · Get Audience Member · Update Audience Member · Patch Audience Member · Delete Audience Member · List Audience Member Events
- AudienceEvent1 endpointList Audience Member Events
- AudienceMemberExternalProfile4 endpointsList External Profiles · Get External Profile · Upsert External Profile · Delete External Profile
- AudienceMemberForeignKey3 endpointsList Foreign Keys · Create Foreign Key · Delete Foreign Key
- AudienceMemberUserAttribute3 endpointsList User Attributes · Set User Attribute · Delete User Attribute
- AuthenticatedIdentity1 endpointDescribe the authenticated identity behind the current request
- Authentication4 endpointsRequest Magic Link · Validate Magic Link · Request OTP · Validate OTP
- PasswordlessAuthentication4 endpointsRequest Magic Link · Validate Magic Link · Request OTP · Validate OTP
- Entitlement4 endpointsList Entitlements · Create Entitlement · Get Entitlement · Revoke Entitlement
- EventQueue2 endpointsList Queued Events · Flush Queued Events
- HeartbeatQueue2 endpointsList Queued Heartbeats · Flush Queued Heartbeats
- Interaction9 endpointsList Interactions · Create Interaction · Get Interaction · Update Interaction · Archive Interaction · Duplicate Interaction · Unpublish Interaction · Restore Interaction · Delete Interaction
- InteractionManagement9 endpointsList Interactions · Create Interaction · Get Interaction · Update Interaction · Archive Interaction · Duplicate Interaction · Unpublish Interaction · Restore Interaction · Delete Interaction
- Milestone5 endpointsList Milestones · Create Milestone · Get Milestone · Update Milestone · Delete Milestone
- Product5 endpointsList Products · Create Product · Get Product · Update Product · Delete Product
- Template1 endpointGet Template
- TenantHealth1 endpointTenant Health Summary
- TokenRecommendation3 endpointsList Recommendations · Record Recommendation Click · Preview Recommendations