Project API

Get WhiteLabel dashboard

get/rest/api/v1/projects/{projectId}/features/{featureId}/whitelabel/dashboard

Request

Base URL
https://api.metacopier.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/metacopier/apis/metacopier-api/docs/rest/api/v1/projects/:projectId/features/:featureId/whitelabel/dashboard/get.ts
A function with typed inputs. Its response is checked against the schema.

projectIdstring uuid required

featureIdstring uuid required

currencystring

Currency used for all financial calculations

isTestStripeKeyboolean

True when the white-label is configured with an sk_test_ Stripe key. Read-only mirror used to drive frontend warnings.

manualCollectionboolean

True when the white-label has opted in to per-customer manual collection (mirrors FeatureWhiteLabelDTO.manualCollection)

totalAccountsinteger

Total number of accounts across all projects

totalActiveAccountsinteger

Total number of active accounts

totalCustomersinteger

Total number of unique customers across all projects

totalInvoicesinteger

Total number of invoices across all projects

totalManualOutstandingnumber

Sum of OPEN invoice amounts across all customers that are eligible for manual collection. Zero when manualCollection=false.

totalOutstandingnumber

Total outstanding amount from unpaid invoices

totalPaidInvoicesinteger

Total number of paid invoices

totalProjectsinteger

Total number of projects linked to this WhiteLabel

totalRevenuenumber

Total revenue from all paid invoices in the WhiteLabel currency

totalUnpaidInvoicesinteger

Total number of unpaid invoices

{
  "projects": [
    {
      "created": "2024-01-15T10:30:00Z"
    }
  ]
}