Get the status of a scheduled Insights-Refresh
This endpoint returns the status of a scheduled insights refresh.
POST /insights/v1/autorefresh/list HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Bearer <Token>
Host: <Host>
{
"insights_consumer_id" : string,
"insights_account_ids" : ?Array<String>
}
The insights_consumer_id of the consumer which the automatic refresh status should be returned. If the insights_account_ids property is not set the status of all scheduled auto refreshs of this consumer are returned.
The insights_account_ids specify the accounts of which the status should be returned.
{
"data": {
"status": [
{
"last_refresh_at": DateTime,
"last_refresh_state": enum<'SUCCESS', 'EXCEPTION'>,
"last_successful_refresh_at": ?DateTime,
"next_refresh_at": DateTime,
"refresh_interval_minutes": int,
"data_retention_minutes": int,
"intended_insights": Array<IntendedReport>,
"refresh_days": ?int,
"insights_account_id": string
}
]
}
}
The state of the last automatic refresh.
In case of a non successful last_refresh_state the error message can be set.
The ISO 8601 date time of the last successful automatic refresh.
The interval minutes that were configured for this automatic refresh.
The minutes that data of this automatic refresh are stored.
The intented insights that were configured for this automatic refresh.
The number of days for transactions that are configured to be refreshed for this automatic refresh.
The identifier of the account for which this automatic refresh status is.
Example response
{
"data": {
"status": [
{
"last_refresh_at": "2021-01-14T16:13:32.781175Z",
"last_refresh_state": "SUCCESS",
"last_successful_refresh_at": "2021-01-14T16:13:32.781175Z",
"next_refresh_at": "2021-01-14T16:43:32.781175Z",
"refresh_interval_minutes": 30,
"data_retention_minutes": 129600,
"intended_insights": [],
"refresh_days": 62,
"insights_account_id": "c312345-f72a-487b-b6aa-a7c796deeac1"
}
]
}
}