GET
/
v1
/
background_jobs
/
{job_id}
Check job status
curl --request GET \
  --url https://analytix.userpilot.io/v1/background_jobs/%7B{job_id}%7D \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "users": [
    {
      "user_id": "<string>",
      "company_id": "<string>",
      "metadata": {
        "last_ticket_created": "2023-11-07T05:31:56Z",
        "tickets_created": "<string>",
        "tickets_resolved": "<string>",
        "tickets_pending": "<string>",
        "avg_resolution_time": "<string>",
        "customer_satisfaction": "<string>",
        "escalation_count": "<string>"
      }
    }
  ]
}'
{
  "completed_rows": 123,
  "elapsed_time": 123,
  "end_time": "<string>",
  "file_size": 123,
  "filename": "<string>",
  "job_id": "<string>",
  "links": "<string>",
  "start_time": "<string>",
  "status": "<string>",
  "total_rows": 123,
  "type": "<string>"
}

Headers

​
Content-Type
string
​
Accept
string
​
Authorization
string
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Path Parameters

​
job_id
string
required

Body

application/json

Response

200 - application/json

OK - Check job status

The response is of type object.