HYhypertrack
Workers
WorkerExport

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.

post/workers/export

Request

Request body

from_datestring nullable

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

to_datestring nullable

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

limitinteger nullable

Number of workers to be sent in response

include_scheduleboolean

Flag to include worker's schedule in the response.

include_summaryboolean

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

ops_group_handlestring nullable

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

profilestring nullable

Profile filter to be applied on the list of workers

worker_handlestring nullable

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

search_termstring nullable

Keyword to match against worker handle, name, or profile

pagination_tokenstring nullable

Identifier used to fetch the next page of data

device_idstring uuid nullable

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

include_deletedboolean

Flag to include deleted workers

from_timestring date-time nullable

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

to_timestring date-time nullable

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

filter_outagestring nullable

Filter workers on a particular outage code.

filter_outage_categorystring nullable

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

filter_geofence_metadatastring nullable

geofence_metadata filter for aggregate response

aggregateboolean

Flag set to retrieve aggregated data over the provided time range

work_statusstring nullable

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

filter_status'active' | 'inactive' | 'disconnected' | 'null' nullable

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

trackedboolean nullable

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

workedboolean nullable

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

intended_to_trackboolean nullable

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

include_lpboolean nullable

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

region_filterstring nullable

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

email_recipientsstring[]

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

Response

Successful response

job_idstring required

Unique identifier for the export job

statusstring required

Current status of the export job: pending, processing, completed, failed

messagestring required

Human-readable message about the job

Changes

No recorded changes to this operation across all 1 revision of this API.