Enumerations
Enumerations used in the request or response payloads.
deviceId
Section titled deviceId-1: All devices0: Unknown1: Desktop2: Mobile (Web)3: Tablet (Web)4: Mobile (App)5: Tablet (App)
format
Section titled formatBeginning of date range for analysis.
CSV: CSV (with first row as headers)JSONL: JSON Lines format, a file format with one line per row of data, each line being a JSON object
frequency
Section titled frequencydaily: daily jobhourly: hourly jobonce: one-time job
scope
Section titled scopesessions: to extract session-level dataviews: to extract pageview-level data
state (job state)
Section titled state (job state)ACTIVE: active jobs (as opposed to SUSPENDED for daily jobs).An active job will execute job runs. A one-time “once” job in ACTIVE status is a job queued waiting for execution.COMPLETED: for completed one-time (“once”) jobs (not relevant for daily jobs)COMPUTING: for running one-time (“once”) jobsDELETED: for deleted jobsSUSPENDED: for deactivated daily jobs (as opposed to ACTIVE); only relevant for daily jobs. A suspended job will not execute job runs.
state (job run state)
Section titled state (job run state)CREATED: for job runs created and not yet RUNNABLEFAILURE: for job runs terminated with an errorRUNNABLE: for job runs ready-to-executeRUNNING: for deleted jobsSUCCESS: for job runs completed with success