API reference / Operations by tag

postbacks

Outgoing postbacks (including CAPI presets), their logs and retries.

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

Operations

Method	Path	Summary
GET	`/partner/mmp-templates`	Partner portal: MMP outbound presets (url_template mmp:, method, config_keys, notes) for a postback that sends conversions to the partner's MMP; the advertiser-side inbound URL is not included
GET	`/partner/postbacks`	List Postbacks
POST	`/partner/postbacks`	Create Postback
GET	`/partner/postbacks/{id}`	Get Postback
PATCH	`/partner/postbacks/{id}`	Update Postback
DELETE	`/partner/postbacks/{id}`	Delete Postback
GET	`/partner/postbacks/{id}/deliveries`	Partner portal: recent deliveries of an own postback
POST	`/partner/postbacks/{id}/test`	Partner portal: send a test of an own postback
POST	`/partner/postbacks/bulk/apply`	Bulk edit apply
POST	`/partner/postbacks/bulk/preview`	Bulk edit preview
POST	`/partner/postbacks/search`	Search Postbacks (advanced)
GET	`/postbacks`	List Postbacks
POST	`/postbacks`	Create Postback
GET	`/postbacks/{id}`	Get Postback
PATCH	`/postbacks/{id}`	Update Postback
DELETE	`/postbacks/{id}`	Delete Postback
POST	`/postbacks/{id}/test`	Send a test postback
POST	`/postbacks/bulk/apply`	Bulk edit apply
POST	`/postbacks/bulk/preview`	Bulk edit preview
POST	`/postbacks/search`	Search Postbacks (advanced)

`GET /partner/mmp-templates`

Partner portal: MMP outbound presets (url_template mmp:, method, config_keys, notes) for a postback that sends conversions to the partner's MMP; the advertiser-side inbound URL is not included

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

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

bash

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

Example 200 response:

json

{
  "data": [
    {}
  ]
}

`GET /partner/postbacks`

List Postbacks

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

bash

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

Example 200 response:

json

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

`POST /partner/postbacks`

Create Postback

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

Request body (application/json, required): PostbackCreate

Field	Type	Flags
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string	required
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

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

bash

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

Example 201 response:

json

{
  "external_ref": ""
}

`GET /partner/postbacks/{id}`

Get Postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /partner/postbacks/{id}`

Update Postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PostbackUpdate

Field	Type	Flags	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /partner/postbacks/{id}`

Delete Postback

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

Example 204 response:

json

{
  "ok": false
}

`GET /partner/postbacks/{id}/deliveries`

Partner portal: recent deliveries of an own postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "rows": [
    {}
  ],
  "next_cursor": "",
  "has_more": false
}

`POST /partner/postbacks/{id}/test`

Partner portal: send a test of an own postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): ConversionCreate

Field	Type	Description
`conversion_id`	string
`click_id`	string
`impression_id`	string
`txn_id`	string
`order_id`	string
`conversion_type`	enum: `base`, `goal`, `event`, `upsell`, `rebill`, `refund`, `chargeback`, `adjustment`
`goal_id`	string
`goal_key`	string
`offer_id`	string
`partner_id`	string
`advertiser_id`	string
`landing_page_id`	string
`creative_id`	string
`coupon_code`	string
`ts`	string (date-time)
`click_ts`	string (date-time)
`ctit_seconds`	integer
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`status_reason`	string
`status_source`	string
`is_hidden_from_partner`	boolean
`payout`	string	decimal string
`revenue`	string	decimal string
`sale_amount`	string	decimal string
`currency`	string
`fx_rate`	string	decimal string
`profit`	string	decimal string
`adv`	object (free-form)	adv1..adv10
`params`	object (free-form)	sub1..sub15, source, ...
`method`	enum: `postback`, `pixel`, `iframe`, `js`, `sdk`, `s2s`, `coupon`, `manual`, `import`
`attribution`	object (free-form)	model, touch, confidence, is_organic
`ip`	string
`click_ip`	string
`geo`	object (free-form)
`device`	object (free-form)
`user_id`	string
`fraud`	object (free-form)	score, reasons, rule_ids
`is_test`	boolean
`raw_request`	string
`history`	array of object (free-form)

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

bash

curl -X POST 'https://api.metrixed.com/v1/partner/postbacks/<id>/test' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"conversion_id":"","click_id":"","impression_id":"","txn_id":""}'

Example 200 response:

json

{
  "rows": [
    {}
  ],
  "next_cursor": "",
  "has_more": false
}

`POST /partner/postbacks/bulk/apply`

Bulk edit apply

Operation postPartnerPostbacksBulkApply. 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/partner/postbacks/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 /partner/postbacks/bulk/preview`

Bulk edit preview

Operation postPartnerPostbacksBulkPreview. 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/partner/postbacks/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 /partner/postbacks/search`

Search Postbacks (advanced)

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

bash

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

List Postbacks

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

bash

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

Example 200 response:

json

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

`POST /postbacks`

Create Postback

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

Request body (application/json, required): PostbackCreate

Field	Type	Flags
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string	required
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

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

bash

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

Example 201 response:

json

{
  "external_ref": ""
}

`GET /postbacks/{id}`

Get Postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /postbacks/{id}`

Update Postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): PostbackUpdate

Field	Type	Flags	Description
`partner_id`	string
`offer_id`	string
`goal_id`	string
`event_scope`	enum: `conversion`, `goal`, `conversion_goal`, `all`
`type`	enum: `url`, `iframe_pixel`, `image_pixel`, `javascript_pixel`
`method`	enum: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
`url_template`	string
`body_template`	string
`headers`	object (free-form)
`status`	enum: `active`, `pending`, `paused`, `disabled`
`allowed_conversion_statuses`	array of enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`block_zero_payout`	boolean
`fire_on`	array of enum: `create`, `status_change`, `payout_change`, `reversal`
`delay_seconds`	integer
`retry_policy`	object (free-form)

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /postbacks/{id}`

Delete Postback

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

Example 204 response:

json

{
  "ok": false
}

`POST /postbacks/{id}/test`

Send a test postback

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): ConversionCreate

Field	Type	Description
`conversion_id`	string
`click_id`	string
`impression_id`	string
`txn_id`	string
`order_id`	string
`conversion_type`	enum: `base`, `goal`, `event`, `upsell`, `rebill`, `refund`, `chargeback`, `adjustment`
`goal_id`	string
`goal_key`	string
`offer_id`	string
`partner_id`	string
`advertiser_id`	string
`landing_page_id`	string
`creative_id`	string
`coupon_code`	string
`ts`	string (date-time)
`click_ts`	string (date-time)
`ctit_seconds`	integer
`status`	enum: `pending`, `approved`, `rejected`, `cancelled`, `extended`, `flagged`, `scrubbed`
`status_reason`	string
`status_source`	string
`is_hidden_from_partner`	boolean
`payout`	string	decimal string
`revenue`	string	decimal string
`sale_amount`	string	decimal string
`currency`	string
`fx_rate`	string	decimal string
`profit`	string	decimal string
`adv`	object (free-form)	adv1..adv10
`params`	object (free-form)	sub1..sub15, source, ...
`method`	enum: `postback`, `pixel`, `iframe`, `js`, `sdk`, `s2s`, `coupon`, `manual`, `import`
`attribution`	object (free-form)	model, touch, confidence, is_organic
`ip`	string
`click_ip`	string
`geo`	object (free-form)
`device`	object (free-form)
`user_id`	string
`fraud`	object (free-form)	score, reasons, rule_ids
`is_test`	boolean
`raw_request`	string
`history`	array of object (free-form)

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

bash

curl -X POST 'https://api.metrixed.com/v1/postbacks/<id>/test' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"conversion_id":"","click_id":"","impression_id":"","txn_id":""}'

Example 200 response:

json

{
  "rows": [
    {}
  ],
  "next_cursor": "",
  "has_more": false
}

`POST /postbacks/bulk/apply`

Bulk edit apply

Operation postPostbacksBulkApply. 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/postbacks/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 /postbacks/bulk/preview`

Bulk edit preview

Operation postPostbacksBulkPreview. 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/postbacks/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 /postbacks/search`

Search Postbacks (advanced)

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

bash

curl -X POST 'https://api.metrixed.com/v1/postbacks/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": {}
}