Salary benchmark

Salary benchmark

Interactive reference and playground for POST /v1/insights/salary/benchmark.

POST
/v1/insights/salary/benchmark
AuthorizationBearer <token>

API key issued from the JobsPipe dashboard, prefixed jp_live_, sent as a bearer token in the Authorization header. Keys are read-only and scoped: jobs:read grants POST /v1/jobs/search, stack:read grants POST /v1/stack/scan. No scope grants write access to JobsPipe data.

In: header

Header Parameters

Idempotency-Key?string

Optional client-generated key (e.g. a UUID) that makes this POST safe to retry. A repeat with the same key returns the original response plus an Idempotent-Replayed: true header. Keys are retained for 24 hours.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Requires occupation_code or title.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/insights/salary/benchmark" \  -H "Content-Type: application/json" \  -d '{    "occupation_code": "2512",    "country": "US",    "seniority": "senior",    "window_days": 90  }'
{  "occupation_code": "2512",  "occupation_label": "Software Developers",  "window_days": 90,  "country": "US",  "count": 1843,  "currency": "USD",  "percentiles": {    "p10": 118000,    "p25": 140000,    "p50": 165000,    "p75": 192000,    "p90": 225000  },  "confidence": "high",  "suppressed": false}
{  "error": "string",  "message": "string"}
{  "error": "string",  "message": "string"}
{  "error": "string"}