Skip to main content

Data Migration - Get My Exports

Endpoint​

/o/datamigration/getmyexports

Overview​

Returns migration export records with derived file-availability flags.

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​

ParameterTypeRequiredDescription
argsJSON String (Object)NoOptional JSON-stringified helper args.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Response​

Success Response​

With exports:

{
  "result": [
    {
      "_id": "f9b35d90be5f2240eafced7c6bfdf130856cd0a7",
      "step": "exporting",
      "status": "progress",
      "progress": 35,
      "can_download": false,
      "have_folder": true,
      "log": "dm-export_f9b35d90be5f2240eafced7c6bfdf130856cd0a7.log"
    }
  ]
}

No exports:

{
  "result": "data-migration.no-exports"
}

Response Fields​

FieldTypeDescription
resultArray or StringExport list or no-exports key.
result[].can_downloadBooleanWhether final archive file exists.
result[].have_folderBooleanWhether unpacked export folder exists.
result[].logStringExport log filename if available.

Error Responses​

  • 404
{
  "result": "Database error message"
}

Behavior/Processing​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Export listRecords found in migration collectionReturns sorted list and annotates each record with file/log availability flags.Wrapped result array
No exportsNo records foundReturns no-exports key.Wrapped string

Impact on Other Data​

  • Read-only endpoint.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.data_migrationsExport status listingReads all migration records sorted by timestamp.

Examples​

List exports​

/o/datamigration/getmyexports

Last Updated​

2026-02-17