Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
aggregator

/api/v1/aggregator/dashboard

GET
/api/v1/aggregator/dashboard
curl --request GET \
  --url 'https://dpg.example.com/api/v1/aggregator/dashboard?page=1&limit=50&status=new&refresh=true' \
  --header 'x-acting-org-id: example' \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1 <= 9007199254740991
limit
integer
default: 50 >= 1 <= 500
domain
string
>= 1 characters
status
string
Allowed values: new active at_risk inactive
q
string
>= 1 characters <= 200 characters
refresh
string
Allowed values: true false

Header Parameters

Section titled “Header Parameters”
x-acting-org-id
required
string

Organization this request acts on behalf of. Required for admin/aggregator operations.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
by_domain
required
object
key
additional properties
object
rollup
required
object
total_items
required
number
complete_profiles
required
number
has_applications
required
number
by_status
required
object
key
additional properties
number
by_initiated_action_status
required
object
key
additional properties
number
by_received_action_status
required
object
key
additional properties
number
total_users
required
number
avg_items_per_user
required
number
avg_actions_per_user
required
number
mode_wise_counts
required
object
key
additional properties
number
items
required
Array<object>
object
profile_item_id
required
string
user_id
required
string
nullable
item_network
required
string
item_domain
required
string
item_type
required
string
name
required
string
onboarded_via
required
string
nullable
profile_status
required
string
nullable
Allowed values: new active at_risk inactive
profile_completion_pct
required
number
nullable
profile_created_at
required
string
nullable
profile_last_updated_at
required
string
nullable
age_days
required
number
nullable
initiated
required
object
key
additional properties
number
received
required
object
key
additional properties
number
last_initiated_at
required
object
key
additional properties
string
last_received_at
required
object
key
additional properties
string
actionable_tags
required
Array<string>
total_matching
required
number
next_cursor
required
string
nullable
metadata
required
object
last_computed_at
required
string
nullable
ttl_seconds
required
number
refreshed
required
boolean
Example
{
  "by_domain": {
    "additionalProperty": {
      "items": [
        {
          "profile_status": "new"
        }
      ]
    }
  }
}