Skip to main content
GET
/
analytics
/
dashboards
/
product-sales-breakdown
/
revenue-breakdown-summary
Get Revenue Breakdown Summary
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/product-sales-breakdown/revenue-breakdown-summary \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "groupKey": "<string>",
  "totalItems": 123,
  "totalQuantity": 123,
  "totalGrossAmount": 123,
  "totalItemDiscountAmount": 123,
  "totalChargeDiscountAmount": 123,
  "totalTaxAmount": 123,
  "totalNetAmount": 123,
  "uniquePatients": 123,
  "uniqueProviders": 123,
  "uniqueLocations": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

timezone
string
required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

start_date
string | null
end_date
string | null
location_ids
string[] | null
location_names
string[] | null
provider_ids
string[] | null
provider_names
string[] | null
patient_ids
string[] | null
patient_names
string[] | null
item_categories
string[] | null
item_types
string[] | null
item_names
string[] | null
payment_mediums
string[] | null
min_net_amount
number | null
max_net_amount
number | null
comment
string | null

Response

Successful Response

Summary statistics for a specific group.

groupKey
string
required

The group key this summary belongs to

totalItems
integer
required

Total number of items in this group

totalQuantity
integer
required

Total quantity (formatted)

totalGrossAmount
integer
required

Total gross amount (formatted as currency)

totalItemDiscountAmount
integer
required

Total item-level discount amount (formatted as currency)

totalChargeDiscountAmount
integer
required

Total charge-level discount amount (formatted as currency)

totalTaxAmount
integer
required

Total tax amount (formatted as currency)

totalNetAmount
integer
required

Total net amount (formatted as currency)

uniquePatients
integer
required

Number of unique patients

uniqueProviders
integer
required

Number of unique providers

uniqueLocations
integer
required

Number of unique locations