API reference / Operations by tag

payouts

Payout and revenue entries, overrides, tiers, scrub rules and revshare runs.

35 operations. Base URL https://api.metrixed.com/v1; see authentication, errors and pagination.

Operations

Method	Path	Summary
GET	`/customer-value-rules`	List CustomerValueRules
POST	`/customer-value-rules`	Create CustomerValueRule
GET	`/customer-value-rules/{id}`	Get CustomerValueRule
PATCH	`/customer-value-rules/{id}`	Update CustomerValueRule
DELETE	`/customer-value-rules/{id}`	Delete CustomerValueRule
POST	`/customer-value-rules/bulk/apply`	Bulk edit apply
POST	`/customer-value-rules/bulk/preview`	Bulk edit preview
POST	`/customer-value-rules/search`	Search CustomerValueRules (advanced)
GET	`/offers/{id}/payout-overrides`	Overrides targeting an offer (plus partner-level ones)
GET	`/offers/{id}/payouts`	List offer payouts
POST	`/offers/{id}/payouts`	Create offer payout
GET	`/payout-entries/{id}`	Get PayoutRevenueEntry
PATCH	`/payout-entries/{id}`	Update PayoutRevenueEntry
DELETE	`/payout-entries/{id}`	Delete PayoutRevenueEntry
GET	`/payout-overrides`	List PayoutOverrides
POST	`/payout-overrides`	Create PayoutOverride
GET	`/payout-overrides/{id}`	Get PayoutOverride
PATCH	`/payout-overrides/{id}`	Update PayoutOverride
DELETE	`/payout-overrides/{id}`	Delete PayoutOverride
POST	`/payout-overrides/bulk/apply`	Bulk edit apply
POST	`/payout-overrides/bulk/preview`	Bulk edit preview
POST	`/payout-overrides/search`	Search PayoutOverrides (advanced)
GET	`/payout-scrub-rules`	List PayoutScrubRules
POST	`/payout-scrub-rules`	Create PayoutScrubRule
GET	`/payout-scrub-rules/{id}`	Get PayoutScrubRule
PATCH	`/payout-scrub-rules/{id}`	Update PayoutScrubRule
DELETE	`/payout-scrub-rules/{id}`	Delete PayoutScrubRule
POST	`/payout-scrub-rules/bulk/apply`	Bulk edit apply
POST	`/payout-scrub-rules/bulk/preview`	Bulk edit preview
POST	`/payout-scrub-rules/search`	Search PayoutScrubRules (advanced)
POST	`/payouts/explain`	Explain which payout entry/override wins for a hypothetical conversion
GET	`/payouts/referral-commissions`	Posted 2-tier referral commissions
GET	`/payouts/settings`	Tenant payout settings (referral defaults, auto-tier window)
PUT	`/payouts/settings`	Update tenant payout settings
POST	`/revshare-runs/preview`	Dry-run a revenue file (rows, payout_percent) or a pending run (run_id): before/after per conversion and totals; writes nothing

`GET /customer-value-rules`

List CustomerValueRules

Operation getCustomerValueRules. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`page`	query	integer	no
`page_size`	query	integer	no
`sort`	query	string	no	field or -field
`include`	query	string	no	comma-separated relationships
`filter`	query	object (free-form)	no
`q`	query	string	no	free-text search

Status	Description	Body
200	ok	application/json CustomerValueRuleList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/customer-value-rules?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /customer-value-rules`

Create CustomerValueRule

Operation postCustomerValueRules. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): CustomerValueRuleCreate

Field	Type	Flags
`name`	string	required
`offer_id`	string
`partner_ids`	array of string
`metric`	enum: `sale_amount`, `revenue`, `ngr`, `conversions`
`period`	enum: `lifetime`, `month`, `quarter`, `year`
`thresholds`	array of object (free-form)
`carry_negative`	boolean
`status`	string
`description`	string

Status	Description	Body
201	ok	application/json CustomerValueRule
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/customer-value-rules' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /customer-value-rules/{id}`

Get CustomerValueRule

Operation getCustomerValueRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json CustomerValueRule
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/customer-value-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /customer-value-rules/{id}`

Update CustomerValueRule

Operation patchCustomerValueRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): CustomerValueRuleUpdate

Field	Type	Flags	Description
`name`	string
`offer_id`	string
`partner_ids`	array of string
`metric`	enum: `sale_amount`, `revenue`, `ngr`, `conversions`
`period`	enum: `lifetime`, `month`, `quarter`, `year`
`thresholds`	array of object (free-form)
`carry_negative`	boolean
`status`	string
`description`	string

Status	Description	Body
200	ok	application/json CustomerValueRule
default	error	application/json Error

bash

curl -X PATCH 'https://api.metrixed.com/v1/customer-value-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","offer_id":"","partner_ids":[""],"metric":"sale_amount"}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /customer-value-rules/{id}`

Delete CustomerValueRule

Operation deleteCustomerValueRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
204	ok	application/json Ok
default	error	application/json Error

bash

curl -X DELETE 'https://api.metrixed.com/v1/customer-value-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /customer-value-rules/bulk/apply`

Bulk edit apply

Operation postCustomerValueRulesBulkApply. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/customer-value-rules/bulk/apply' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /customer-value-rules/bulk/preview`

Bulk edit preview

Operation postCustomerValueRulesBulkPreview. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/customer-value-rules/bulk/preview' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /customer-value-rules/search`

Search CustomerValueRules (advanced)

Operation postCustomerValueRulesSearch. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): SearchRequest

Field	Type	Flags	Description
`filters`	array of object
`search`	string
`sort`	array of object (free-form)
`page`	integer
`page_size`	integer
`include`	array of string

Status	Description	Body
200	ok	application/json CustomerValueRuleList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/customer-value-rules/search' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{}],"search":"","sort":[{}],"page":0}'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`GET /offers/{id}/payout-overrides`

Overrides targeting an offer (plus partner-level ones)

Operation getOffersIdPayoutOverrides. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json PayoutOverrideList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/offers/<id>/payout-overrides' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`GET /offers/{id}/payouts`

List offer payouts

Operation getOffersIdPayouts. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json PayoutRevenueEntryList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/offers/<id>/payouts' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /offers/{id}/payouts`

Create offer payout

Operation postOffersIdPayouts. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PayoutRevenueEntryCreate

Field	Type	Description
`goal_id`	string
`entry_name`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`tier_metric`	enum: `conversions`, `revenue`, `sales`, `ftd`
`tier_period`	enum: `month`, `lifetime`
`tier_apply_to`	enum: `partner`, `tier`
`is_default`	boolean
`is_private`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve_conversion`	boolean
`is_allow_duplicate_conversion`	boolean
`is_apply_all_partners`	boolean
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`city`	array of string
`landing_page_ids`	array of string
`variable`	string
`allowed_values`	array of string
`rule_set_id`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`priority`	integer
`description`	string
`public_description`	string
`status`	enum: `active`, `inactive`

Status	Description	Body
201	ok	application/json PayoutRevenueEntry
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/offers/<id>/payouts' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"goal_id":"","entry_name":"","payout_type":"fixed","payout_amount":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /payout-entries/{id}`

Get PayoutRevenueEntry

Operation getPayoutEntriesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json PayoutRevenueEntry
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payout-entries/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /payout-entries/{id}`

Update PayoutRevenueEntry

Operation patchPayoutEntriesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PayoutRevenueEntryUpdate

Field	Type	Description
`goal_id`	string
`entry_name`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_click`, `per_mille`, `per_sku`, `kpi_scaled`, `tiered`, `blank`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`tier_metric`	enum: `conversions`, `revenue`, `sales`, `ftd`
`tier_period`	enum: `month`, `lifetime`
`tier_apply_to`	enum: `partner`, `tier`
`is_default`	boolean
`is_private`	boolean
`is_postback_disabled`	boolean
`is_enforce_caps`	boolean
`is_must_approve_conversion`	boolean
`is_allow_duplicate_conversion`	boolean
`is_apply_all_partners`	boolean
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`city`	array of string
`landing_page_ids`	array of string
`variable`	string
`allowed_values`	array of string
`rule_set_id`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`priority`	integer
`description`	string
`public_description`	string
`status`	enum: `active`, `inactive`

Status	Description	Body
200	ok	application/json PayoutRevenueEntry
default	error	application/json Error

bash

curl -X PATCH 'https://api.metrixed.com/v1/payout-entries/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"goal_id":"","entry_name":"","payout_type":"fixed","payout_amount":""}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /payout-entries/{id}`

Delete PayoutRevenueEntry

Operation deletePayoutEntriesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
204	ok	application/json Ok
default	error	application/json Error

bash

curl -X DELETE 'https://api.metrixed.com/v1/payout-entries/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`GET /payout-overrides`

List PayoutOverrides

Operation getPayoutOverrides. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`page`	query	integer	no
`page_size`	query	integer	no
`sort`	query	string	no	field or -field
`include`	query	string	no	comma-separated relationships
`filter`	query	object (free-form)	no
`q`	query	string	no	free-text search

Status	Description	Body
200	ok	application/json PayoutOverrideList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payout-overrides?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /payout-overrides`

Create PayoutOverride

Operation postPayoutOverrides. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): PayoutOverrideCreate

Field	Type	Flags	Description
`name`	string	required
`offer_id`	string
`goal_id`	string
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`device_types`	array of string
`os`	array of string
`variable`	string
`allowed_values`	array of string
`skus`	array of string
`product_categories`	array of string
`date_valid_from`	string (date-time)
`date_valid_to`	string (date-time)
`hours_of_day`	array of integer
`days_of_week`	array of integer
`timezone`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`payout_amount`	string		decimal string
`payout_percentage`	string		decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`revenue_amount`	string		decimal string
`revenue_percentage`	string		decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`priority`	integer
`status`	string
`description`	string

Status	Description	Body
201	ok	application/json PayoutOverride
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-overrides' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /payout-overrides/{id}`

Get PayoutOverride

Operation getPayoutOverridesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json PayoutOverride
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payout-overrides/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /payout-overrides/{id}`

Update PayoutOverride

Operation patchPayoutOverridesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PayoutOverrideUpdate

Field	Type	Description
`name`	string
`offer_id`	string
`goal_id`	string
`partner_ids`	array of string
`partner_tier_id`	string
`geo`	array of string
`region`	array of string
`device_types`	array of string
`os`	array of string
`variable`	string
`allowed_values`	array of string
`skus`	array of string
`product_categories`	array of string
`date_valid_from`	string (date-time)
`date_valid_to`	string (date-time)
`hours_of_day`	array of integer
`days_of_week`	array of integer
`timezone`	string
`payout_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`payout_amount`	string	decimal string
`payout_percentage`	string	decimal string
`revenue_type`	enum: `fixed`, `percent_of_sale`, `fixed_plus_percent`, `per_sku`, `tiered`, `kpi_scaled`, `blank`, `inherit`
`revenue_amount`	string	decimal string
`revenue_percentage`	string	decimal string
`currency`	string
`calc_param`	string
`sku_table`	array of object (free-form)
`tiers`	array of object (free-form)
`priority`	integer
`status`	string
`description`	string

Status	Description	Body
200	ok	application/json PayoutOverride
default	error	application/json Error

bash

curl -X PATCH 'https://api.metrixed.com/v1/payout-overrides/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","offer_id":"","goal_id":"","partner_ids":[""]}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /payout-overrides/{id}`

Delete PayoutOverride

Operation deletePayoutOverridesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
204	ok	application/json Ok
default	error	application/json Error

bash

curl -X DELETE 'https://api.metrixed.com/v1/payout-overrides/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /payout-overrides/bulk/apply`

Bulk edit apply

Operation postPayoutOverridesBulkApply. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-overrides/bulk/apply' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /payout-overrides/bulk/preview`

Bulk edit preview

Operation postPayoutOverridesBulkPreview. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-overrides/bulk/preview' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /payout-overrides/search`

Search PayoutOverrides (advanced)

Operation postPayoutOverridesSearch. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): SearchRequest

Field	Type	Flags	Description
`filters`	array of object
`search`	string
`sort`	array of object (free-form)
`page`	integer
`page_size`	integer
`include`	array of string

Status	Description	Body
200	ok	application/json PayoutOverrideList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-overrides/search' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{}],"search":"","sort":[{}],"page":0}'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`GET /payout-scrub-rules`

List PayoutScrubRules

Operation getPayoutScrubRules. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`page`	query	integer	no
`page_size`	query	integer	no
`sort`	query	string	no	field or -field
`include`	query	string	no	comma-separated relationships
`filter`	query	object (free-form)	no
`q`	query	string	no	free-text search

Status	Description	Body
200	ok	application/json PayoutScrubRuleList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payout-scrub-rules?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /payout-scrub-rules`

Create PayoutScrubRule

Operation postPayoutScrubRules. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): PayoutScrubRuleCreate

Field	Type	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`percentage`	string	decimal string
`to_status`	enum: `pending`, `rejected`, `scrubbed`
`zero_payout`	boolean
`status`	string
`description`	string

Status	Description	Body
201	ok	application/json PayoutScrubRule
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-scrub-rules' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"partner_id":"","offer_id":"","goal_id":"","percentage":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /payout-scrub-rules/{id}`

Get PayoutScrubRule

Operation getPayoutScrubRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json PayoutScrubRule
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payout-scrub-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /payout-scrub-rules/{id}`

Update PayoutScrubRule

Operation patchPayoutScrubRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PayoutScrubRuleUpdate

Field	Type	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`percentage`	string	decimal string
`to_status`	enum: `pending`, `rejected`, `scrubbed`
`zero_payout`	boolean
`status`	string
`description`	string

Status	Description	Body
200	ok	application/json PayoutScrubRule
default	error	application/json Error

bash

curl -X PATCH 'https://api.metrixed.com/v1/payout-scrub-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"partner_id":"","offer_id":"","goal_id":"","percentage":""}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /payout-scrub-rules/{id}`

Delete PayoutScrubRule

Operation deletePayoutScrubRulesId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
204	ok	application/json Ok
default	error	application/json Error

bash

curl -X DELETE 'https://api.metrixed.com/v1/payout-scrub-rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /payout-scrub-rules/bulk/apply`

Bulk edit apply

Operation postPayoutScrubRulesBulkApply. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-scrub-rules/bulk/apply' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /payout-scrub-rules/bulk/preview`

Bulk edit preview

Operation postPayoutScrubRulesBulkPreview. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-scrub-rules/bulk/preview' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /payout-scrub-rules/search`

Search PayoutScrubRules (advanced)

Operation postPayoutScrubRulesSearch. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): SearchRequest

Field	Type	Flags	Description
`filters`	array of object
`search`	string
`sort`	array of object (free-form)
`page`	integer
`page_size`	integer
`include`	array of string

Status	Description	Body
200	ok	application/json PayoutScrubRuleList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payout-scrub-rules/search' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{}],"search":"","sort":[{}],"page":0}'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /payouts/explain`

Explain which payout entry/override wins for a hypothetical conversion

Operation postPayoutsExplain. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): Ok

Field	Type	Flags	Description
`ok`	boolean

Status	Description	Body
200	ok	application/json Ok
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/payouts/explain' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ok":false}'

Example 200 response:

json

{
  "ok": false
}

`GET /payouts/referral-commissions`

Posted 2-tier referral commissions

Operation getPayoutsReferralCommissions. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`page`	query	integer	no
`page_size`	query	integer	no
`sort`	query	string	no	field or -field
`include`	query	string	no	comma-separated relationships
`filter`	query	object (free-form)	no
`q`	query	string	no	free-text search

Status	Description	Body
200	ok	application/json Ok
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payouts/referral-commissions?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "ok": false
}

`GET /payouts/settings`

Tenant payout settings (referral defaults, auto-tier window)

Operation getPayoutsSettings. Auth: API key (Bearer) or session cookie.

Status	Description	Body
200	ok	application/json Ok
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/payouts/settings' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "ok": false
}

`PUT /payouts/settings`

Update tenant payout settings

Operation putPayoutsSettings. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): Ok

Field	Type	Flags	Description
`ok`	boolean

Status	Description	Body
200	ok	application/json Ok
default	error	application/json Error

bash

curl -X PUT 'https://api.metrixed.com/v1/payouts/settings' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ok":false}'

Example 200 response:

json

{
  "ok": false
}

`POST /revshare-runs/preview`

Dry-run a revenue file (rows, payout_percent) or a pending run (run_id): before/after per conversion and totals; writes nothing

Operation postRevshareRunsPreview. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): RevsharePreviewRequest

Status	Description	Body
200	ok	application/json RevsharePreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/revshare-runs/preview' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 200 response:

json

{}