Create an analysis job

Queues the job and returns 202. Poll GET /analyses/{id}, stream GET /analyses/{id}/events, or wait for the analysis.completed webhook, then page GET /analyses/{id}/results.

post/analyses

Request

  • Base URL: https://api.instalent.io/api/v1
  • URL: https://api.instalent.io/api/v1/analyses
  • Auth: HTTP bearer and API key in header X-Customer-Key

Headers

Idempotency-Keystring

8 to 128 characters. A retry with the same key returns the original job.

Request body

profileIdsstring[] required
criteriastring[] required

Response

Replayed: this Idempotency-Key already created a job, so the original is returned.

idstring required
kind'search' | 'enrichment' | 'analysis' required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
inputobject required
summaryobject nullable required
createdAtstring required
startedAtstring nullable required
finishedAtstring nullable required

Changes

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