API ExplorerLabour Market Insights
Salary benchmark
Interactive reference and playground for POST /v1/insights/salary/benchmark.
Authorization
apiKey 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": "string", "occupation_label": "string", "window_days": 0, "country": "string", "count": 0, "currency": "USD", "percentiles": { "p10": 0, "p25": 0, "p50": 0, "p75": 0, "p90": 0 }, "confidence": "low", "suppressed": true}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "rate_limited", "limit": 0, "count": 0}