Overview
Explore our HTTP APIs and how to use them.
Build advanced use cases around personalized experiences, data pipelines, and integrations with our API services.
Services
Below is a list of available API services:
| Service | Endpoint | Use Case |
|---|---|---|
| Data Export | /export | Export events, sessions, and user data to data lakes, warehouses, and analytics platforms for deep analysis and reporting. |
| Content Service | /content | Deliver personalized content, A/B test variants, and feature flags based on user context and audience targeting. |
| Evaluation Service | /evaluate | Evaluate CQL queries in real-time to power dynamic personalization logic and decision-making. |
| Event Tracker | /track | Track user events, interactions, and behaviors to build comprehensive user profiles for personalization. |
Base URL
All endpoints have the following base URL:
https://api.croct.ioAuthentication
For endpoints requiring authentication, include an API key in the headers:
X-Api-Key: <API KEY>You can generate and manage API keys in the application page.
Rate limit
All endpoints enforce rate limiting to ensure fair usage and maintain service quality. Check specific service documentation for details.
Requests
Requests follow REST architectural style using standard HTTP methods:
| Method | Description |
|---|---|
GET | Retrieve resources. |
POST | Create or submit resources. |
PUT | Update resources. |
PATCH | Partially update resources. |
DELETE | Remove resources. |
Request bodies should be in JSON format when required.
Errors
Failed requests return an appropriate HTTP status code with an error response body following the Problem Details (RFC 7807) specification.
{ "title": "Invalid input", "type": "https://croct.help/api/invalid-input", "status": 400, "detail": "The request contains invalid parameters",}You can always open the link provided in the type field to get more information about the error.
Each error includes:
- titlestring
A short, human-readable summary of the problem type.
- typestring
A URI reference identifying the problem type. This URI provides detailed documentation about the error.
- statusinteger
The HTTP status code for this occurrence of the problem.
- detail(optional)string
A human-readable explanation specific to this occurrence of the problem.
For detailed error documentation, see the specific service documentation or visit the error type URI provided in the response.