API Reference

Get Spending Metrics

get
https://staging.southparkdata.com/rest/v0/company//metrics/spending

Retrieves payroll and non-payroll spending metrics for the given period range. Provide startPeriod and endPeriod in YYYY-MM format.

Required scope: read:company

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

The company ID

Query Params
string
required
length ≥ 1

Calendar date, YYYY-MM-DD

string
length ≥ 1

Calendar date, YYYY-MM-DD

string
enum

The value is normalized before matching, so any casing that maps onto a listed value is accepted.

Allowed:
Response

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?