analysis

Get Insight Job Status

Get insight job status.

get/api/analysis/{team_key}/jobs/insight-consolidation/{job_key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

job_keystring required
team_keystring required

Response

Successful Response

keystring required

Job key

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

Status of a job.

insightType'it_team' | 'dev_team' required

Type of insights

dateFilterMonthsinteger required

Date filter in months

dateFromstring date-time nullable required

Start of explicit date range

dateTostring date-time nullable required

End of explicit date range

recommendationCountinteger required

Number of recommendations

startedAtstring date-time nullable required

Start time

completedAtstring date-time nullable required

Completion time

errorMessagestring nullable required

Error message if failed

createdAtstring date-time required

Creation time

Changes

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