Analyze an import
/imports/{import_id}/analysesStarts an asynchronous analysis of the import spreadsheet and returns the operation that tracks it. The Location header points to that operation.
Requires the imports.analyze permission. An import can be analyzed again before it is processed; the new analysis replaces the previous one.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/imports/string/analyses"{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}Delete an import DELETE
Moves the import to the trash. Only imports that have not been processed can be deleted. Deleting an import does not undo its effects: rows already queued for processing continue, and enrollments already granted remain in place.
List processing attempts GET
Returns the processing attempts requested through the API for the specified import. Processing started outside the API does not appear in this list.