Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
aggregator-config

Public brand + network config

GET
/v1/aggregator-config
curl --request GET \
  --url https://aggregator.example.com/v1/aggregator-config

Brand palette/logo + per-domain labels (tab name, plural, tiles, status_rules) + dashboard bucket labels. Web BFF reads this at boot to theme the portal and render the dashboard config-driven.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
aggregator
required
object
name
required
string
legal_name
string
contact_email
string
key
additional properties
any
brand
required
object
short_name
required
string
long_name
required
string
tagline
string
strapline
string
url_slug
required
string
primary_color
string
accent_color
string
logo_url
string
favicon_url
string
attribution
Array<object>
object
label
required
string
name
required
string
logo
string
logoLight
string
key
additional properties
any
network
required
object
id
required
string
display_name
string
key
additional properties
any
domains
required
Array<object>
object
id
required
string
label
required
string
plural_label
required
string
item_type
required
string
guardian_consent_required
required
boolean
go_live_required
required
Array<string>
key
additional properties
any
dashboardBuckets
object
by_status
object
key
additional properties
string
by_action_status
object
key
additional properties
string
key
additional properties
any
registration_modes
required
object
key
additional properties
object
label
string
signals_cta
required
boolean
key
additional properties
any
signals_ui_urls
required
object
key
additional properties
string
key
additional properties
any
Examplegenerated
{
  "aggregator": {
    "name": "example",
    "legal_name": "example",
    "contact_email": "example"
  },
  "brand": {
    "short_name": "example",
    "long_name": "example",
    "tagline": "example",
    "strapline": "example",
    "url_slug": "example",
    "primary_color": "example",
    "accent_color": "example",
    "logo_url": "example",
    "favicon_url": "example",
    "attribution": [
      {
        "label": "example",
        "name": "example",
        "logo": "example",
        "logoLight": "example"
      }
    ]
  },
  "network": {
    "id": "example",
    "display_name": "example"
  },
  "domains": [
    {
      "id": "example",
      "label": "example",
      "plural_label": "example",
      "item_type": "example",
      "guardian_consent_required": true,
      "go_live_required": [
        "example"
      ]
    }
  ],
  "dashboardBuckets": {
    "by_status": {
      "additionalProperty": "example"
    },
    "by_action_status": {
      "additionalProperty": "example"
    }
  },
  "registration_modes": {
    "additionalProperty": {
      "label": "example",
      "signals_cta": true
    }
  },
  "signals_ui_urls": {
    "additionalProperty": "example"
  }
}

500

Section titled “500”

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"
  }
}

503

Section titled “503”

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"
  }
}