Skip to main content
POST
/
api
/
admin
/
histories
/
charts
/
cross-institution
Compare specific institutions side-by-side
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/histories/charts/cross-institution \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institution": "60d5ec9af682fbd39c3a1234 60d5ec9af682fbd39c3a5678",
  "granularity": "month",
  "range": -12,
  "dimension": "count",
  "includeTotal": false
}
'
{
  "success": true,
  "data": [
    {
      "_id": {
        "granularity": "<string>",
        "institution": "<string>"
      },
      "dimension": 123
    }
  ],
  "institutionNames": {}
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
institution
string
required

Space-separated institution IDs to compare

Example:

"60d5ec9af682fbd39c3a1234 60d5ec9af682fbd39c3a5678"

​
granularity
enum<string>
default:month
Available options:
month,
week,
day,
hour
​
range
number

Number of time periods to look back (negative for past)

Example:

-12

​
dimension
enum<string>
default:count
Available options:
count,
credits,
usage,
cached,
price,
users
​
includeTotal
boolean
default:false

Include a total series summing all institutions per bucket

Response

Successfully retrieved cross-institution chart data

​
success
boolean
​
data
object[]
​
institutionNames
object

Map of institution ID to display name