Skip to main content

Account Aggregation



Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to multipart/form-data. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.


Path Parameters

    id stringrequired

    Source Id

    Example: ef38f94347e94562b5bb8424a56397d8


    file binary

    The CSV file containing the source accounts to aggregate.

    disableOptimization string

    Use this flag to reprocess every account whether or not the data has changed.


Aggregate Accounts Task

    success boolean

    Default value: true

    The status of the result

    task object
    id string

    System-generated unique ID of the task this taskStatus represents

    type string

    Type of task this task represents

    name string

    The name of the aggregation process

    description string

    The description of the task

    launcher string

    The user who initiated the task

    created date-time

    The Task creation date

    launched date-timenullable

    The task start date

    completed date-timenullable

    The task completion date

    completionStatus stringnullable


    Task completion status.

    parentName stringnullable

    Name of the parent task if exists.

    messages object[]

    List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors.

  • Array [
  • type string

    Possible values: [INFO, WARN, ERROR]

    Type of the message.

    error boolean

    Default value: false

    Flag whether message is an error.

    warning boolean

    Default value: false

    Flag whether message is a warning.

    key string

    Message string identifier.

    localizedText string

    Message context with the locale based language.

  • ]
  • progress stringnullable

    Current task state.

    attributes object

    Extra attributes map(dictionary) for the task.

    appId string

    The id of the source

    optimizedAggregation string

    The indicator if the aggregation process was enabled/disabled for the aggregation job

    property name* object
    returns object[]

    Return values from the task

  • Array [
  • displayLabel string

    The display label of the return value

    attributeName string

    The attribute name of the return value

  • ]