API reference / Operations by tag

rules

Targeting rule sets, lists, day-parting and scheduled actions.

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

Operations

Method	Path	Summary
GET	`/dayparting`	List DaypartingSchedules
POST	`/dayparting`	Create DaypartingSchedule
GET	`/dayparting/{id}`	Get DaypartingSchedule
PATCH	`/dayparting/{id}`	Update DaypartingSchedule
DELETE	`/dayparting/{id}`	Delete DaypartingSchedule
POST	`/dayparting/bulk/apply`	Bulk edit apply
POST	`/dayparting/bulk/preview`	Bulk edit preview
POST	`/dayparting/search`	Search DaypartingSchedules (advanced)
GET	`/lists`	List Lists
POST	`/lists`	Create List
GET	`/lists/{id}`	Get List
PATCH	`/lists/{id}`	Update List
DELETE	`/lists/{id}`	Delete List
POST	`/lists/{id}/sync`	Queue a URL sync of the list
POST	`/lists/{id}/upload`	Upload list values (CSV/text; mode replace\|append\|remove)
POST	`/lists/bulk/apply`	Bulk edit apply
POST	`/lists/bulk/preview`	Bulk edit preview
POST	`/lists/search`	Search Lists (advanced)
GET	`/rules`	List RuleSets
POST	`/rules`	Create RuleSet
GET	`/rules/{id}`	Get RuleSet
PATCH	`/rules/{id}`	Update RuleSet
DELETE	`/rules/{id}`	Delete RuleSet
POST	`/rules/bulk/apply`	Bulk edit apply
POST	`/rules/bulk/preview`	Bulk edit preview
GET	`/rules/catalog`	Rule builder catalog (operators, variables, scopes)
GET	`/rules/conversion-catalog`	Actions (allow, deny, hold, mark), variables and operators of conversion rules
POST	`/rules/search`	Search RuleSets (advanced)
POST	`/rules/test`	Evaluate a draft rule set against a sample click with the edge matcher (lists resolved); reports the outcome and each condition
POST	`/rules/validate`	Validate a rule set without saving

`GET /dayparting`

List DaypartingSchedules

Operation getDayparting. 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 DaypartingScheduleList
default	error	application/json Error

bash

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

Example 200 response:

json

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

`POST /dayparting`

Create DaypartingSchedule

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

Request body (application/json, required): DaypartingScheduleCreate

Field	Type	Flags	Description
`name`	string
`offer_id`	string	required
`partner_id`	string
`timezone`	string		IANA zone; empty = tenant caps_timezone
`windows`	array of object	required
`outside_action`	enum: `block`, `fail_traffic`
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`status`	enum: `active`, `paused`

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

bash

curl -X POST 'https://api.metrixed.com/v1/dayparting' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"offer_id":"","windows":[{}]}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /dayparting/{id}`

Get DaypartingSchedule

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /dayparting/{id}`

Update DaypartingSchedule

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): DaypartingScheduleUpdate

Field	Type	Description
`name`	string
`offer_id`	string
`partner_id`	string
`timezone`	string	IANA zone; empty = tenant caps_timezone
`windows`	array of object
`outside_action`	enum: `block`, `fail_traffic`
`fail_traffic_target`	object (free-form)	type offer\|offer_url\|offer_group\|smartlink, routing_value, reason_categories[]
`status`	enum: `active`, `paused`

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /dayparting/{id}`

Delete DaypartingSchedule

Operation deleteDaypartingId. 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/dayparting/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /dayparting/bulk/apply`

Bulk edit apply

Operation postDaypartingBulkApply. 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/dayparting/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 /dayparting/bulk/preview`

Bulk edit preview

Operation postDaypartingBulkPreview. 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/dayparting/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 /dayparting/search`

Search DaypartingSchedules (advanced)

Operation postDaypartingSearch. 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 DaypartingScheduleList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/dayparting/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 /lists`

List Lists

Operation getLists. 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 ListList
default	error	application/json Error

bash

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

Example 200 response:

json

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

`POST /lists`

Create List

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

Request body (application/json, required): ListCreate

Field	Type	Flags
`name`	string	required
`kind`	enum: `ip`, `isp`, `subid`, `domain`, `referrer`, `suppression`, `email_suppression`, `asn`, `device_id`, `custom`	required
`values`	array of string
`file_ref`	string
`description`	string
`status`	enum: `active`, `paused`
`source_url`	string
`sync_interval_minutes`	integer

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

bash

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

Example 201 response:

json

{
  "external_ref": ""
}

`GET /lists/{id}`

Get List

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /lists/{id}`

Update List

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): ListUpdate

Field	Type	Flags	Description
`name`	string
`kind`	enum: `ip`, `isp`, `subid`, `domain`, `referrer`, `suppression`, `email_suppression`, `asn`, `device_id`, `custom`
`values`	array of string
`file_ref`	string
`description`	string
`status`	enum: `active`, `paused`
`source_url`	string
`sync_interval_minutes`	integer

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/lists/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","kind":"ip","values":[""],"file_ref":""}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /lists/{id}`

Delete List

Operation deleteListsId. 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/lists/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /lists/{id}/sync`

Queue a URL sync of the list

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 202 response:

json

{
  "ok": false
}

`POST /lists/{id}/upload`

Upload list values (CSV/text; mode replace|append|remove)

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

Parameter	In	Type	Required	Description
`id`	path	string	yes
`mode`	query	enum: `replace`, `append`, `remove`	no

Request body (application/json, required): any

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

bash

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

Example 200 response:

json

{
  "ok": false
}

`POST /lists/bulk/apply`

Bulk edit apply

Operation postListsBulkApply. 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/lists/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 /lists/bulk/preview`

Bulk edit preview

Operation postListsBulkPreview. 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/lists/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 /lists/search`

Search Lists (advanced)

Operation postListsSearch. 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 ListList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/lists/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 /rules`

List RuleSets

Operation getRules. 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 RuleSetList
default	error	application/json Error

bash

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

Example 200 response:

json

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

`POST /rules`

Create RuleSet

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

Request body (application/json, required): RuleSetCreate

Field	Type	Flags	Description
`name`	string	required
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`	required
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)		target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer		WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`		WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

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

bash

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

Example 201 response:

json

{
  "external_ref": ""
}

`GET /rules/{id}`

Get RuleSet

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /rules/{id}`

Update RuleSet

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): RuleSetUpdate

Field	Type	Description
`name`	string
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)	target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer	WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`	WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","scope_entity_type":"offer","scope_entity_id":"","event_scope":"click"}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /rules/{id}`

Delete RuleSet

Operation deleteRulesId. 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/rules/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`POST /rules/bulk/apply`

Bulk edit apply

Operation postRulesBulkApply. 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/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 /rules/bulk/preview`

Bulk edit preview

Operation postRulesBulkPreview. 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/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": ""
}

`GET /rules/catalog`

Rule builder catalog (operators, variables, scopes)

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

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

bash

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

Example 200 response:

json

{
  "operators": [
    {}
  ],
  "variables": [
    {}
  ],
  "scope_kinds": [
    ""
  ],
  "actions": [
    ""
  ]
}

`GET /rules/conversion-catalog`

Actions (allow, deny, hold, mark), variables and operators of conversion rules

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

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

bash

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

Example 200 response:

json

{
  "actions": [
    ""
  ],
  "variables": [
    {}
  ],
  "operators": [
    {}
  ],
  "hold_then": [
    ""
  ]
}

`POST /rules/search`

Search RuleSets (advanced)

Operation postRulesSearch. 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 RuleSetList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/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 /rules/test`

Evaluate a draft rule set against a sample click with the edge matcher (lists resolved); reports the outcome and each condition

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

Request body (application/json, required): RuleTestRequest

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

bash

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

Example 200 response:

json

{}

`POST /rules/validate`

Validate a rule set without saving

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

Request body (application/json, required): RuleSetCreate

Field	Type	Flags	Description
`name`	string	required
`scope_entity_type`	enum: `offer`, `landing_page`, `smartlink_entry`, `internal_redirect`, `payout_entry`, `cap`, `fraud_rule`, `tenant`	required
`scope_entity_id`	string
`event_scope`	enum: `click`, `impression`, `conversion`, `event`, `all`
`match`	enum: `all`, `any`
`partner_ids`	array of string
`excluded_partner_ids`	array of string
`action`	enum: `allow`, `deny`, `route_to`, `fail_traffic`, `mark`, `hold`
`fail_traffic_target`	object (free-form)		target_type offer\|offer_url\|offer_group\|smartlink, target_id, routing_value, is_pay_affiliate, is_pass_through, reason_categories[]
`rules`	array of object
`priority`	integer
`status`	string
`date_valid_from`	string (date)
`date_valid_to`	string (date)
`hold_minutes`	integer		WP-80: action hold (event_scope conversion only): minutes the conversion stays on hold (status extended), 1-129600
`hold_then`	enum: `approved`, `rejected`		WP-80: status the hold scheduler sets when the hold ends
`scope_kind`	enum: `all`, `partner`, `offer`, `geo`
`scope_values`	array of string
`description`	string

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

bash

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

Example 200 response:

json

{
  "ok": false
}