post
https://platform.{env}.simpplr.com/v1/b2b/analytics/export
Configure which analytics data entities your organization receives as recurring CSV exports via SFTP. This is typically a one-time setup — once registered, the system automatically exports data on the configured schedule without further action.
How it works
- Choose which entities to export (e.g.
user,content,user logins) and how often (daily,weekly, ormonthly). - First export delivers the complete historical data (full load) for each registered entity.
- Subsequent exports deliver only incremental (delta) data — records from the previous period — keeping file sizes manageable.
- Exported CSV files are delivered to a secure, SFTP-accessible location partitioned by date:
/exports/<tenant-id>/<year>/<month>/<day>/<entity>/<entity>.csv
Replace semantics
Each call replaces your entire export configuration. The entities you include in the request become your active set; any previously registered entities not present in the new request are deactivated. To add a single entity without affecting others, first retrieve your current configuration via GET /export, then submit the full updated list.
Quick example
{
"exportOption": "export selected",
"entityList": ["user", "content", "user logins", "interaction"],
"frequency": "daily"
}Field reference
| Field | Description |
|---|---|
| exportOption | export all — register every supported entity (entityList is ignored); export selected (default) — register only the entities listed in entityList; disable export — deactivate all exports for the tenant. |
| entityList | One or more entity names (array or comma-separated string). Required when exportOption is export selected. Uses human-readable display names — e.g. user logins instead of user_login_events, must reads instead of content_must_read_marked. See the schema for the full list. |
| frequency | daily (default) — exported every day; weekly — exported every Monday; monthly — exported on the 1st of each month. |