Data Migration - Get Status

Endpoint

/o/datamigration/getstatus

Overview

Returns one migration status record by export ID.

Authentication

Countly API supports three authentication methods:

1. API key query parameter: api_key=YOUR_API_KEY
2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions

Requires data_migration Read permission.

Request Parameters

Parameter	Type	Required	Description
exportid	String	Yes	Migration export ID.
args	JSON String (Object)	No	Optional JSON-stringified helper args.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

Response

Success Response

{
  "result": {
    "_id": "f9b35d90be5f2240eafced7c6bfdf130856cd0a7",
    "step": "sending",
    "status": "progress",
    "progress": 78,
    "reason": "",
    "apps": ["6991c75b024cb89cdc04efd2"],
    "ts": 1739971200000
  }
}

Response Fields

Field	Type	Description
result	Object	Migration status object.
result.step	String	Current lifecycle step (for example exporting, packing, sending, importing).
result.status	String	Current status (for example progress, finished, failed).
result.progress	Number	Progress percentage or progress counter.
result.reason	String	Failure or status reason text.

Error Responses

• 404

{
  "result": "data-migration.invalid-exportid"
}

• 200 (missing exportid branch uses raw output)

"data-migration.exportid-missing"

Behavior/Processing

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Status found	Valid exportid with existing record	Returns migration record.	Wrapped status object
Missing ID	exportid omitted	Returns raw string via raw response body.	Raw root string
Invalid ID	Record not found	Returns invalid-export key.	Wrapped string

Impact on Other Data

• Read-only endpoint.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.data_migrations	Migration status lookup	Reads migration record by _id.

---

Examples

Get status for one export

/o/datamigration/getstatus?
  exportid=f9b35d90be5f2240eafced7c6bfdf130856cd0a7

Related Endpoints

• Data Migration - Export
• Data Migration - Send Existing Export

Last Updated

2026-02-17