Skip to main content

In-progress Account Aggregation status

This API returns the status of an in-progress account aggregation, along with the total number of NEW, CHANGED and DELETED accounts found since the previous aggregation, and the number of those accounts that have been processed so far.

Accounts that have not changed since the previous aggregation are not included in totalAccounts and processedAccounts counts returned by this API. This is distinct from Accounts Scanned shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.

Since this endpoint reports on the status of an in-progress account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint.

Only available up to an hour after the aggregation completes. May respond with 404 Not Found after that.

A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.

Path Parameters
  • id string required

    The account aggregation id

    Example: 2c91808477a6b0c60177a81146b8110b
Responses

An account aggregation status object


Schema
  • start date-time

    When the aggregation started.

  • status string

    Possible values: [STARTED, ACCOUNTS_COLLECTED, COMPLETED, CANCELLED, RETRIED, TERMINATED]

    STARTED - Aggregation started, but source account iteration has not completed.

    ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed.

    COMPLETED - Aggregation completed (possibly with errors).

    CANCELLED - Aggregation cancelled by user.

    RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance.

    TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance.

  • totalAccounts integer

    The total number of NEW, CHANGED and DELETED accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. Only available when status is ACCOUNTS_COLLECTED or COMPLETED.

  • processedAccounts integer

    The number of NEW, CHANGED and DELETED accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. Only available when status is ACCOUNTS_COLLECTED or COMPLETED.

Loading...