retrieval

List retrieval source runs

List the most recent sync runs for a retrieval source, newest first.

Required permission: retrieval.view.

get/v1/projects/{project_id}/retrieval/sources/{source_id}/runs

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/sources/{source_id}/runs
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

source_idstring uuid required

Retrieval source ID from GET /retrieval/sources.

Query parameters

environment_idstring uuid required

Environment ID from GET /environments.

limitinteger

Maximum number of runs to return.

Response

Successful Response

idstring required
statusstring required

running, completed, failed, or skipped when the sync could not run, for example because Project credit ran out.

triggerstring required

scheduled for interval syncs, including the first sync after connecting, or manual for syncs started with POST /retrieval/sources/{source_id}/sync.

items_seeninteger required

Items found at the source, such as pages, articles, or URLs.

ingestedinteger required

New items added to retrieval.

updatedinteger required

Changed items ingested again.

deletedinteger required

Items removed from retrieval because they no longer exist at the source. Always 0 with on_delete: keep.

billable_itemsinteger required

Items charged to Project credit: ingested plus updated.

errorstring nullable required

Why the run failed or was skipped, or a JSON string with a file_issues list when it completed with file problems; null otherwise.

started_atstring required

ISO 8601 timestamp in UTC.

finished_atstring nullable required

ISO 8601 timestamp in UTC; null while the run is running.

Changes

No recorded changes to this operation across all 2 revisions of this API.