Meiro CDP API
Home of all CDP functions accessible over the API.
Base URL
https://instance_name.meiro.io/api/
Home of all CDP functions accessible over the API.
instance_name in API URL should be replaced by the required instance.
Quick Request
Authentication
Authentication is based on API token sent in header. The token must be present in all requests to the API.
Authorization
Each user has assigned role which contains a specific set of the features. The features are needed for accessing the API resources. An authorization error with 403 code is returned in case of an unauthorized request. Required features are described in the resources' sections.
Pagination
All requests returning collections of records have optional parameters limit and offset for paging. Default number of records returned by API of the collection is 20 and they are ordered from the newest to oldest = descending based on timestamp.
Plain/Full data response
Returned entity data are plain by default - the sub-entities are represented only by their ID. If you want to retrieve data of sub-entities, set parameter load_full_structure to 1.
Media Types
Communication of API is entirely in application/json - both Request Body and Response Body where applicable are in JSON.
Error States
The common HTTP Response Status Codes are used.
Sections
- Data Structures
- Authentication
- Identity
- User Roles
- Users
- Notifications
- Segments
- Segment's Notes
- Segment Export Destinations
- Segment Exports
- Web Banners
- Segments' ACL
- Funnel Groups' ACL
- Global Settings
- Customer Entities
- Attributes
- Attribute Aggregations
- Customer Attributes
- Customer Stitching Graph
- Events
- Customers' Event Counts
- Customer Events
- Customer Event Groups
- Customers Search
- Create Customer Events
- Data Sources
- Customers' Attribute Values Counts
- Tags
- CDM Tags
- Segments' Tags
- Stitching Category Rules
- Trash
- Cache
- MI Workspaces
- Reports
- Tools
- System
- PromoCodes
- Push Notifications
- Push Notification Activations
- Push Notification Exports
- Emails
- Email Activations
- Email Exports
- WhatsApp Activations
- Whatsapp Exports
- Whatsapp Blocking/Unblocking
- Customer Participation
- Channels
- Images
- Email Templates
- Stitching Categories
- Email Blocking/Unblocking
- Funnel Charts
- Funnel Groups
- Audience API
- Journeys
- Destinations
- ContextQuery
- ContextQueryCreate
- ContextQueryUpdate
- Context Queries API
- Custom Blocks in Emails
- Global Blocks in Emails
- CDP Entities
- Feeds
- Debugger