Skip to main content
GET
/
analytics
/
dashboards
/
memberships
/
groups
/
{group_by}
Get Membership Analytics Groups
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/memberships/groups/{group_by} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "membership_ids": [],
  "member_statuses": [],
  "location_ids": [],
  "sold_by_provider_ids": []
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
group_by
string
required

Query Parameters

​
location_ids
string[]
​
membership_ids
string[]
​
member_statuses
string[]
​
sold_by_provider_ids
string[]
​
page
integer | null
​
per_page
integer | null
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
patient_name
string | null
​
created_date_start
string<date-time> | null
​
created_date_end
string<date-time> | null
​
start_date_start
string<date-time> | null
​
start_date_end
string<date-time> | null
​
next_billing_date_start
string<date-time> | null
​
next_billing_date_end
string<date-time> | null
​
timezone
string
default:UTC

Body

application/json
​
membership_ids
string[]
​
member_statuses
enum<string>[]
Available options:
ACTIVE,
EXPIRED,
CANCELLED,
DELINQUENT,
FROZEN
​
location_ids
string[]
​
sold_by_provider_ids
string[]

Response

Successful Response