API reference / Operations by tag
admin
Admin utilities: testers, usage, audit-adjacent tools, portal configuration and questionnaires.
37 operations. Base URL https://api.metrixed.com/v1; see authentication, errors and pagination.
Operations
| Method | Path | Summary |
|---|---|---|
| GET | /advertiser/questionnaire | Signup questions and own answers |
| POST | /advertiser/questionnaire | Save own answers |
| GET | /advertiser/terms | Current terms and whether this user must accept |
| POST | /advertiser/terms/accept | Accept the current terms |
| GET | /partner/questionnaire | Signup questions and own answers |
| POST | /partner/questionnaire | Save own answers |
| GET | /partner/terms | Current terms and whether this user must accept |
| POST | /partner/terms/accept | Accept the current terms |
| GET | /questionnaire/answers/{kind}/{id} | Signup answers joined with question text |
| GET | /questionnaire/questions | List SignupQuestions |
| POST | /questionnaire/questions | Create SignupQuestion |
| GET | /questionnaire/questions/{id} | Get SignupQuestion |
| PATCH | /questionnaire/questions/{id} | Update SignupQuestion |
| DELETE | /questionnaire/questions/{id} | Delete SignupQuestion |
| POST | /questionnaire/questions/bulk/apply | Bulk edit apply |
| POST | /questionnaire/questions/bulk/preview | Bulk edit preview |
| POST | /questionnaire/questions/search | Search SignupQuestions (advanced) |
| GET | /terms-acceptances | Terms acceptance log |
| GET | /terms-status | Users who still owe the current terms |
| GET | /terms-versions | List TermsVersions |
| POST | /terms-versions | Create TermsVersion |
| GET | /terms-versions/{id} | Get TermsVersion |
| PATCH | /terms-versions/{id} | Update TermsVersion |
| DELETE | /terms-versions/{id} | Delete TermsVersion |
| POST | /terms-versions/{id}/publish | Publish a draft terms version (retires the previous one) |
| POST | /terms-versions/bulk/apply | Bulk edit apply |
| POST | /terms-versions/bulk/preview | Bulk edit preview |
| POST | /terms-versions/search | Search TermsVersions (advanced) |
| GET | /timeline | Merged activity timeline: audit log, notes, billing events |
| POST | /tools/decode | Decode any tracking link into canonical parameters |
| POST | /tools/encode | Build a tracking link in any style |
| GET | /tools/ledger-trace | Ledger lines created by the given source record ids |
| POST | /tools/link-test | Fetch a tracking link on the edge and trace redirects (never requests the advertiser destination) |
| GET | /tools/macros | Macro registry (inbound aliases, outbound groups) |
| POST | /tools/macros | Expand a macro template with sample values |
| POST | /tools/postback-test | Send a test=1 postback to ingest and report the outcome |
| GET | /usage | Plan limits and daily API activity (clicks/conversions/events come from /reports/query) |
GET /advertiser/questionnaire
Signup questions and own answers
Operation getAdvertiserQuestionnaire. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/advertiser/questionnaire' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /advertiser/questionnaire
Save own answers
Operation postAdvertiserQuestionnaire. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/advertiser/questionnaire' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
GET /advertiser/terms
Current terms and whether this user must accept
Operation getAdvertiserTerms. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/advertiser/terms' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /advertiser/terms/accept
Accept the current terms
Operation postAdvertiserTermsAccept. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/advertiser/terms/accept' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
GET /partner/questionnaire
Signup questions and own answers
Operation getPartnerQuestionnaire. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/partner/questionnaire' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /partner/questionnaire
Save own answers
Operation postPartnerQuestionnaire. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/partner/questionnaire' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
GET /partner/terms
Current terms and whether this user must accept
Operation getPartnerTerms. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/partner/terms' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /partner/terms/accept
Accept the current terms
Operation postPartnerTermsAccept. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/partner/terms/accept' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
GET /questionnaire/answers/{kind}/{id}
Signup answers joined with question text
Operation getQuestionnaireAnswersKindId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | yes | |
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/questionnaire/answers/<kind>/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
GET /questionnaire/questions
List SignupQuestions
Operation getQuestionnaireQuestions. 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 SignupQuestionList |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/questionnaire/questions?page=1&page_size=50' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{
"data": [
{}
],
"page": {}
}
POST /questionnaire/questions
Create SignupQuestion
Operation postQuestionnaireQuestions. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): SignupQuestionCreate
| Field | Type | Flags | Description |
|---|---|---|---|
portal | enum: partner, advertiser | ||
key | string | ||
label | string | required | |
help | string | ||
kind | enum: text, textarea, select, multiselect, checkbox, url, number | ||
options | array of string | ||
required | boolean | ||
position | integer | ||
status | enum: active, archived |
| Status | Description | Body |
|---|---|---|
| 201 | ok | application/json SignupQuestion |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/questionnaire/questions' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"label":""}'
Example 201 response:
{
"external_ref": ""
}
GET /questionnaire/questions/{id}
Get SignupQuestion
Operation getQuestionnaireQuestionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json SignupQuestion |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/questionnaire/questions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{
"external_ref": ""
}
PATCH /questionnaire/questions/{id}
Update SignupQuestion
Operation patchQuestionnaireQuestionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body (application/json, required): SignupQuestionUpdate
| Field | Type | Flags | Description |
|---|---|---|---|
portal | enum: partner, advertiser | ||
key | string | ||
label | string | ||
help | string | ||
kind | enum: text, textarea, select, multiselect, checkbox, url, number | ||
options | array of string | ||
required | boolean | ||
position | integer | ||
status | enum: active, archived |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json SignupQuestion |
| default | error | application/json Error |
curl -X PATCH 'https://api.metrixed.com/v1/questionnaire/questions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"portal":"partner","key":"","label":"","help":""}'
Example 200 response:
{
"external_ref": ""
}
DELETE /questionnaire/questions/{id}
Delete SignupQuestion
Operation deleteQuestionnaireQuestionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
curl -X DELETE 'https://api.metrixed.com/v1/questionnaire/questions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 204 response:
{
"ok": false
}
POST /questionnaire/questions/bulk/apply
Bulk edit apply
Operation postQuestionnaireQuestionsBulkApply. 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 |
curl -X POST 'https://api.metrixed.com/v1/questionnaire/questions/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:
{
"affected": 0,
"changes": [
{}
],
"warnings": [
""
],
"token": ""
}
POST /questionnaire/questions/bulk/preview
Bulk edit preview
Operation postQuestionnaireQuestionsBulkPreview. 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 |
curl -X POST 'https://api.metrixed.com/v1/questionnaire/questions/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:
{
"affected": 0,
"changes": [
{}
],
"warnings": [
""
],
"token": ""
}
POST /questionnaire/questions/search
Search SignupQuestions (advanced)
Operation postQuestionnaireQuestionsSearch. 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 SignupQuestionList |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/questionnaire/questions/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:
{
"data": [
{}
],
"page": {}
}
GET /terms-acceptances
Terms acceptance log Terms acceptance log. WP-67: paged; q matches the email or subject id.
Operation getTermsAcceptances. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
q | query | string | no | |
page | query | string | no | |
page_size | query | string | no | |
sort | query | string | no | |
portal | query | string | no | |
subject_id | query | string | no | |
terms_version_id | query | string | no |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/terms-acceptances?page=1&page_size=50' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
GET /terms-status
Users who still owe the current terms Users who still owe the current terms. WP-67: paged; page.total (and total) is how many accounts still owe the live version.
Operation getTermsStatus. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
q | query | string | no | |
page | query | string | no | |
page_size | query | string | no | |
sort | query | string | no | |
portal | query | string | no |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/terms-status?page=1&page_size=50' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
GET /terms-versions
List TermsVersions
Operation getTermsVersions. 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 TermsVersionList |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/terms-versions?page=1&page_size=50' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{
"data": [
{}
],
"page": {}
}
POST /terms-versions
Create TermsVersion
Operation postTermsVersions. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): TermsVersionCreate
| Field | Type | Flags | Description |
|---|---|---|---|
portal | enum: partner, advertiser | ||
title | string | required | |
body | string | ||
requires_reacceptance | boolean |
| Status | Description | Body |
|---|---|---|
| 201 | ok | application/json TermsVersion |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/terms-versions' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"title":""}'
Example 201 response:
{
"external_ref": ""
}
GET /terms-versions/{id}
Get TermsVersion
Operation getTermsVersionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json TermsVersion |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/terms-versions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{
"external_ref": ""
}
PATCH /terms-versions/{id}
Update TermsVersion
Operation patchTermsVersionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body (application/json, required): TermsVersionUpdate
| Field | Type | Flags | Description |
|---|---|---|---|
portal | enum: partner, advertiser | ||
title | string | ||
body | string | ||
requires_reacceptance | boolean |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json TermsVersion |
| default | error | application/json Error |
curl -X PATCH 'https://api.metrixed.com/v1/terms-versions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"portal":"partner","title":"","body":"","requires_reacceptance":false}'
Example 200 response:
{
"external_ref": ""
}
DELETE /terms-versions/{id}
Delete TermsVersion
Operation deleteTermsVersionsId. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
curl -X DELETE 'https://api.metrixed.com/v1/terms-versions/<id>' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 204 response:
{
"ok": false
}
POST /terms-versions/{id}/publish
Publish a draft terms version (retires the previous one)
Operation postTermsVersionsIdPublish. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/terms-versions/<id>/publish' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
POST /terms-versions/bulk/apply
Bulk edit apply
Operation postTermsVersionsBulkApply. 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 |
curl -X POST 'https://api.metrixed.com/v1/terms-versions/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:
{
"affected": 0,
"changes": [
{}
],
"warnings": [
""
],
"token": ""
}
POST /terms-versions/bulk/preview
Bulk edit preview
Operation postTermsVersionsBulkPreview. 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 |
curl -X POST 'https://api.metrixed.com/v1/terms-versions/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:
{
"affected": 0,
"changes": [
{}
],
"warnings": [
""
],
"token": ""
}
POST /terms-versions/search
Search TermsVersions (advanced)
Operation postTermsVersionsSearch. 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 TermsVersionList |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/terms-versions/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:
{
"data": [
{}
],
"page": {}
}
GET /timeline
Merged activity timeline: audit log, notes, billing events
Operation getTimeline. Auth: API key (Bearer) or session cookie.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
entity_type | query | enum: offer, partner, advertiser, smartlink | yes | |
entity_id | query | string | yes | |
limit | query | integer | no |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/timeline' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /tools/decode
Decode any tracking link into canonical parameters
Operation postToolsDecode. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/tools/decode' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
POST /tools/encode
Build a tracking link in any style
Operation postToolsEncode. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/tools/encode' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
GET /tools/ledger-trace
Ledger lines created by the given source record ids
Operation getToolsLedgerTrace. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/tools/ledger-trace' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /tools/link-test
Fetch a tracking link on the edge and trace redirects (never requests the advertiser destination)
Operation postToolsLinkTest. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): LinkTestRequest
| Field | Type | Flags | Description |
|---|---|---|---|
url | string | required | Tracking link (absolute, on one of your tracking domains) or a path such as /c/OFFER_HASH/PARTNER_HASH?sub1=x |
test | boolean | Mark the click as test traffic (stored, shown in logs with is_test, excluded from reports and the ledger) | |
headers | object (free-form) | Extra request headers to send to the edge (for example User-Agent or X-Geo-Country) |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/tools/link-test' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"url":""}'
Example 200 response:
{}
GET /tools/macros
Macro registry (inbound aliases, outbound groups)
Operation getToolsMacros. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/tools/macros' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}
POST /tools/macros
Expand a macro template with sample values
Operation postToolsMacros. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): ToolResult
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/tools/macros' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Example 200 response:
{}
POST /tools/postback-test
Send a test=1 postback to ingest and report the outcome
Operation postToolsPostbackTest. Auth: API key (Bearer) or session cookie.
Request body (application/json, required): PostbackTestRequest
| Field | Type | Flags | Description |
|---|---|---|---|
params | object (free-form) | required | Postback parameters (at least click_id or txn_id; goal, amount, currency, security_token ...); sent to ingest with test=1 |
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl -X POST 'https://api.metrixed.com/v1/tools/postback-test' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{"params":{}}'
Example 200 response:
{}
GET /usage
Plan limits and daily API activity (clicks/conversions/events come from /reports/query)
Operation getUsage. Auth: API key (Bearer) or session cookie.
| Status | Description | Body |
|---|---|---|
| 200 | ok | application/json ToolResult |
| default | error | application/json Error |
curl 'https://api.metrixed.com/v1/usage' \
-H "Authorization: Bearer $DT_API_KEY" \
-H 'Accept: application/json'
Example 200 response:
{}