Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
onboarding

Aggregated onboarding totals

GET
/v1/onboarding/summary
curl --request GET \
  --url https://aggregator.example.com/v1/onboarding/summary \
  --header 'Authorization: Bearer <token>'

Sum of total / passed / failed / skipped onboarding attempts for the caller aggregator, optionally constrained by ?from=&to= ISO dates.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
string format: date-time
to
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
total
required
integer
passed
required
integer
failed
required
integer
skipped
required
integer
aggregator_id
required
string
from
required
string
nullable
to
required
string
nullable
key
additional properties
any
Examplegenerated
{
  "total": 1,
  "passed": 1,
  "failed": 1,
  "skipped": 1,
  "aggregator_id": "example",
  "from": "example",
  "to": "example"
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}