API reference / Operations by tag

smartlinks

SmartLinks: one link that routes traffic across a pool of offers.

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

Operations

Method	Path	Summary
GET	`/smartlinks`	List Smartlinks
POST	`/smartlinks`	Create Smartlink
GET	`/smartlinks/{id}`	Get Smartlink
PATCH	`/smartlinks/{id}`	Update Smartlink
DELETE	`/smartlinks/{id}`	Delete Smartlink
GET	`/smartlinks/{id}/offers`	List member offers
POST	`/smartlinks/{id}/offers`	Add member offer
PATCH	`/smartlinks/{id}/offers/{entry_id}`	Update member offer (priority, weight, filters)
DELETE	`/smartlinks/{id}/offers/{entry_id}`	Remove member offer
GET	`/smartlinks/{id}/report`	Smartlink performance by member offer (reporting engine, dimension smartlink)
POST	`/smartlinks/{id}/simulate`	Simulate clicks: which member offer N clicks (country, device, os, partner) would get and why the others are skipped. Same ranking as the edge; caps and live KPI stats are not applied
POST	`/smartlinks/{id}/tracking-link`	Generate smartlink tracking link (+QR PNG data URL)
POST	`/smartlinks/bulk/apply`	Bulk edit apply
POST	`/smartlinks/bulk/delete`	Delete up to 500 smartlinks in one transaction (dry_run: true previews without saving)
POST	`/smartlinks/bulk/preview`	Bulk edit preview
POST	`/smartlinks/search`	Search Smartlinks (advanced)

`GET /smartlinks`

List Smartlinks

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

bash

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

Example 200 response:

json

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

`POST /smartlinks`

Create Smartlink

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

Request body (application/json, required): SmartlinkCreate

Field	Type	Flags	Description
`name`	string	required
`description`	string
`status`	enum: `active`, `paused`, `archived`
`event`	enum: `click`, `impression`
`type`	enum: `manual`, `category`
`routing_type`	enum: `priority`, `weight`, `kpi_auto`, `round_robin`, `epc`
`lookback_hours`	integer
`kpi`	object (free-form)		metric epc\|cr, min_clicks
`offer_group_id`	string
`advertiser_ids`	array of string
`categories`	array of string
`allowed_partner_ids`	array of string
`blocked_partner_ids`	array of string
`is_open_to_partners`	boolean
`catch_all_offer_id`	string
`fail_traffic_target`	object (free-form)		type offer\|offer_url\|offer_group\|smartlink, routing_value
`fallback_url`	string
`targeting`	object (free-form)		geo_allow[], geo_deny[], device_types[], os[]
`append_url`	object (free-form)		key -> value
`tags`	array of string
`tracking_domain_id`	string
`is_use_secure_link`	boolean
`hash_id`	string

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

bash

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

Example 201 response:

json

{
  "hash_id": "",
  "external_ref": ""
}

`GET /smartlinks/{id}`

Get Smartlink

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "hash_id": "",
  "external_ref": ""
}

`PATCH /smartlinks/{id}`

Update Smartlink

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): SmartlinkUpdate

Field	Type	Description
`name`	string
`description`	string
`status`	enum: `active`, `paused`, `archived`
`event`	enum: `click`, `impression`
`type`	enum: `manual`, `category`
`routing_type`	enum: `priority`, `weight`, `kpi_auto`, `round_robin`, `epc`
`lookback_hours`	integer
`kpi`	object (free-form)	metric epc\|cr, min_clicks
`offer_group_id`	string
`advertiser_ids`	array of string
`categories`	array of string
`allowed_partner_ids`	array of string
`blocked_partner_ids`	array of string
`is_open_to_partners`	boolean
`catch_all_offer_id`	string
`fail_traffic_target`	object (free-form)	type offer\|offer_url\|offer_group\|smartlink, routing_value
`fallback_url`	string
`targeting`	object (free-form)	geo_allow[], geo_deny[], device_types[], os[]
`append_url`	object (free-form)	key -> value
`tags`	array of string
`tracking_domain_id`	string
`is_use_secure_link`	boolean
`hash_id`	string

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/smartlinks/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","description":"","status":"active","event":"click"}'

Example 200 response:

json

{
  "hash_id": "",
  "external_ref": ""
}

`DELETE /smartlinks/{id}`

Delete Smartlink

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

Example 204 response:

json

{
  "ok": false
}

`GET /smartlinks/{id}/offers`

List member offers

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

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

`POST /smartlinks/{id}/offers`

Add member offer

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): SmartlinkOfferCreate

Field	Type	Flags
`smartlink_id`	string
`offer_id`	string	required
`status`	enum: `active`, `paused`
`priority`	integer
`weight`	integer
`geo_allow`	array of string
`geo_deny`	array of string
`device_types`	array of string
`os`	array of string

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

bash

curl -X POST 'https://api.metrixed.com/v1/smartlinks/<id>/offers' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"offer_id":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`PATCH /smartlinks/{id}/offers/{entry_id}`

Update member offer (priority, weight, filters)

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

Parameter	In	Type	Required	Description
`id`	path	string	yes
`entry_id`	path	string	yes

Request body (application/json, required): SmartlinkOfferUpdate

Field	Type	Flags	Description
`smartlink_id`	string
`offer_id`	string
`status`	enum: `active`, `paused`
`priority`	integer
`weight`	integer
`geo_allow`	array of string
`geo_deny`	array of string
`device_types`	array of string
`os`	array of string

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/smartlinks/<id>/offers/<entry_id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"smartlink_id":"","offer_id":"","status":"active","priority":0}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /smartlinks/{id}/offers/{entry_id}`

Remove member offer

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

Parameter	In	Type	Required	Description
`id`	path	string	yes
`entry_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/smartlinks/<id>/offers/<entry_id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`GET /smartlinks/{id}/report`

Smartlink performance by member offer (reporting engine, dimension smartlink)

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "columns": [
    {}
  ],
  "rows": [
    [
      {}
    ]
  ],
  "totals": {},
  "next_cursor": ""
}

`POST /smartlinks/{id}/simulate`

Simulate clicks: which member offer N clicks (country, device, os, partner) would get and why the others are skipped. Same ranking as the edge; caps and live KPI stats are not applied

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): SmartlinkSimulateRequest

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

bash

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

Example 200 response:

json

{}

`POST /smartlinks/{id}/tracking-link`

Generate smartlink tracking link (+QR PNG data URL)

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): TrackingLinkRequest

Field	Type	Flags	Description
`partner_id`	string	required
`tracking_domain_id`	string
`landing_page_id`	string
`creative_id`	string
`style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`params`	object (free-form)		sub1.. source etc.
`deep_link`	string
`encode_deep_link`	boolean
`with_qr`	boolean
`with_pixels`	boolean
`google_ads_format`	boolean
`force_transparent`	boolean

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

bash

curl -X POST 'https://api.metrixed.com/v1/smartlinks/<id>/tracking-link' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"partner_id":""}'

Example 200 response:

json

{
  "url": "",
  "impression_url": "",
  "click_pixel_html": "",
  "impression_pixel_html": ""
}

`POST /smartlinks/bulk/apply`

Bulk edit apply

Operation postSmartlinksBulkApply. 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/smartlinks/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 /smartlinks/bulk/delete`

Delete up to 500 smartlinks in one transaction (dry_run: true previews without saving)

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

Request body (application/json, required): BulkDeleteRequest

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

bash

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

Example 200 response:

json

{}

`POST /smartlinks/bulk/preview`

Bulk edit preview

Operation postSmartlinksBulkPreview. 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/smartlinks/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 /smartlinks/search`

Search Smartlinks (advanced)

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

bash

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