Skip to main content
GET
/
dashboard
/
api
/
v1
/
stats
/
{organization_id}
Get dashboard statistics
curl --request GET \
  --url https://www.closient.com/dashboard/api/v1/stats/{organization_id} \
  --header 'X-API-Key: <api-key>'
{
  "total_products": 1,
  "complete_products": 1,
  "avg_completeness": 50,
  "active_offers": 1,
  "broken_offers": 1,
  "expiring_certifications": 1,
  "missing_images": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

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

200 - application/json

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 /trade-items/{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 (url_status in broken, timeout, dns_failure). 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