API Reference
Log In
API Reference

Create or replace job type economics

put
https://api.revenium.ai/profitstream/v2/api/jobs/types//economics

Creates or replaces the economics for this job type: the metrics you report, how they turn into value, and your overhead cost.

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

The job type name you send with your jobs, in lowercase.

Query Params
string
required

The ID of your team, a short string ID such as jR2kmLs.

Body Params

Request to create or replace a job type economics declaration

string

The key of the metric that counts one unit of work. It must be one of the declared metrics and must have type COUNT. At most 64 characters.

string

Label shown for the unit of work. At most 64 characters.

metrics
array of objects

The metrics you report for this job type. At least one, at most 100, each key unique.

metrics
dimensions
array of objects

The dimensions you can attach to period facts, each with its allowed values. Optional, at most 20.

dimensions
monetization
number | null

Optional. Your overhead cost for each unit of work, in USD. Zero or more, at most 1,000,000,000. Send it together with overheadCurrency.

string | null

Optional. Currency of overheadPerUnit. Must be USD today, and sent together with overheadPerUnit.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?