Create a worker export job

Creates an asynchronous job to export workers to CSV.gz file. Returns a job_id that can be used to check status. Download link will be sent via email when ready.

Authorization

AuthorizationBasic <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

from_date?|

ISO 8601 date format ('yyyy-MM-dd') indicating the start date to be used for the summary computation.Default: Current date in UTC.

to_date?|

ISO 8601 date format ('yyyy-MM-dd') indicating the end date to be used for the summary computation.Default: Current date in UTC.

limit?|

Number of workers to be sent in response

include_schedule?boolean

Flag to include worker's schedule in the response.

include_summary?boolean

Flag to include worker's summary stats in the response.

ops_group_handle?|

List of ops group handles as comma separated strings used to filter workers.

profile?|

Profile filter to be applied on the list of workers

worker_handle?|

List of worker handles as comma separated strings used for fetching associated workers

search_term?|

Keyword to match against worker handle, name, or profile

pagination_token?|

Identifier used to fetch the next page of data

device_id?|

Unique identifier for a worker's device. This field is present in case the worker is currently linked with a device

include_deleted?boolean

Flag to include deleted workers

from_time?|

Deprecated

ISO 8601 datetime indicating the start time to be used for computing summary, status.

to_time?|

Deprecated

ISO 8601 datetime indicating the end time to be used for computing summary, status.

filter_outage?|

Filter workers on a particular outage code.

filter_outage_category?|

List of comma separated outage categories to be used for filtering workers. Valid categories: behavioural,adversarial,reachability,os,sporadic

filter_geofence_metadata?|

geofence_metadata filter for aggregate response

aggregate?boolean

Flag set to retrieve aggregated data over the provided time range

work_status?|

URL-encoded json string specifying filters on availability or tracking.

filter_status?|

Only list workers that are currently active/inactive/disconnected.

tracked?|

If set to true, only shows workers that were actually tracked during the specified period.

worked?|

If set to true, only shows workers that actually during the specified period.

intended_to_track?|

If set to true, only shows workers that was supposed to be tracked during the specified period.

include_lp?|

Flag to include location permission stats in response (only applicable when aggregate=True).

region_filter?|

URL-encoded JSON string used to filter workers from a particular region. Ex {"city":"Detroit"}

email_recipients?array<string>

Optional list of email addresses to send the export download link. Falls back to the account email when omitted.

Response Body

`application/json`

curl -X POST "https://example.com/workers/export" \  -H "Content-Type: application/json" \  -d '{}'

{  "job_id": "string",  "status": "string",  "message": "string"}

{  "detail": {},  "message": "string"}

{  "detail": {    "<location>": {      "<field_name>": [        "string"      ]    }  },  "message": "string"}

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`