v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Quarter to Date Report

Create a quarter to date report.

post/reports/qtd

Request body

companyIDstring required

The ID of the company

employeeIDstring[]

Array of employee IDs to grab QTD data for

quarterstring required

The quarter to grab QTD data for (options are q1, q2, q3, and q4)

media_typestring required

The media_type of the report, currently only supporting json

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "e560b4e3-71a5-49cb-aedc-8e8yy3db81a",
    "status": "pending",
    "request_body": {
      "companyID": "fcc26cc444450ac8a33ry32a3z34462",
      "employeeID": [
        "6266y546eyecc34458aef1"
      ],
      "quarter": "q1",
      "media_type": "json",
      "has_live_key": true,
      "job_type": "reports",
      "report_format": "qtd"
    },
    "created_at": "2023-12-07T18:49:28.679Z"
  }
}