API reference / Operations by tag

landing-pages

Landing pages and pre-landers of an offer.

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

Operations

Method	Path	Summary
GET	`/landing-pages`	List LandingPages
GET	`/landing-pages/{id}`	Get LandingPage
PATCH	`/landing-pages/{id}`	Update LandingPage
DELETE	`/landing-pages/{id}`	Delete LandingPage
POST	`/landing-pages/{id}/preview`	Expand landing-page URL macros with sample values
POST	`/landing-pages/bulk/delete`	Delete up to 500 landing pages in one transaction (dry_run: true previews without saving)
POST	`/landing-pages/search`	Search LandingPages (advanced)
GET	`/offers/{id}/landing-pages`	List offer landing-pages
POST	`/offers/{id}/landing-pages`	Create offer landing-page

`GET /landing-pages`

List LandingPages

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

bash

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

Example 200 response:

json

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

`GET /landing-pages/{id}`

Get LandingPage

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /landing-pages/{id}`

Update LandingPage

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): LandingPageUpdate

Field	Type	Flags	Description
`title`	string
`url`	string
`preview_url`	string
`lp_type`	enum: `landing`, `prelanding`, `targeting_group`
`status`	string
`is_default`	boolean
`split_urls`	array of object (free-form)
`weight`	integer
`rule_set_id`	string
`partner_visibility`	enum: `all`, `specific`
`partner_ids`	array of string

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/landing-pages/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"title":"","url":"","preview_url":"","lp_type":"landing"}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /landing-pages/{id}`

Delete LandingPage

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

Example 204 response:

json

{
  "ok": false
}

`POST /landing-pages/{id}/preview`

Expand landing-page URL macros with sample values

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "ok": false
}

`POST /landing-pages/bulk/delete`

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

Operation postLandingPagesBulkDelete. 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/landing-pages/bulk/delete' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 200 response:

json

{}

`POST /landing-pages/search`

Search LandingPages (advanced)

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

bash

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

List offer landing-pages

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

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

`POST /offers/{id}/landing-pages`

Create offer landing-page

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): LandingPageCreate

Field	Type	Flags
`title`	string	required
`url`	string	required
`preview_url`	string
`lp_type`	enum: `landing`, `prelanding`, `targeting_group`
`status`	string
`is_default`	boolean
`split_urls`	array of object (free-form)
`weight`	integer
`rule_set_id`	string
`partner_visibility`	enum: `all`, `specific`
`partner_ids`	array of string

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

bash

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

Example 201 response:

json

{
  "external_ref": ""
}