Skip to main content
GET
Get dashboard statistics

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization to summarize.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

Aggregated metrics rendered on the brand dashboard home page.

total_products
integer
required

Count of every product owned by the organization (any status).

Required range: x >= 0
Example:

1250

complete_products
integer
required

Count of products whose completeness score is 80 or higher. Uses the same scoring as GET /products/{org}/{gtin}/completeness.

Required range: x >= 0
Example:

980

avg_completeness
integer
required

Average completeness percentage across every product (0-100, rounded to the nearest integer). 0 when the org has no products.

Required range: 0 <= x <= 100
Example:

78

active_offers
integer
required

Total active offers across both in-store and online channels for this organization. Counts only offers with status='active'.

Required range: x >= 0
Example:

45

broken_offers
integer
required

Online offers whose URL check is currently failing (the link is broken, timed out or failed DNS lookup). Brand managers triage these on the dashboard home.

Required range: x >= 0
Example:

3

expiring_certifications
integer
required

Certification assignments whose expiry_date falls in the next 60 days but is still in the future. Excludes already-expired certs.

Required range: x >= 0
Example:

12

missing_images
integer
required

Distinct products owned by the organization that have zero ProductImage rows attached.

Required range: x >= 0
Example:

87