API reference
MCP tool reference
Every tool the Metrixed MCP server exposes, per audience. The token (or OAuth grant) decides the audience: staff tokens get the network tools, partner tokens the partner tools, advertiser tokens the advertiser tools. A tool is listed only when the token carries its scope. This page is generated from the server's tool table.
Rate limit: 120 requests per minute per token (configurable with DT_MCP_RATE_PER_MINUTE). See MCP server for setup.
Scopes
| Scope | Audiences | Grants |
|---|---|---|
reports:read | Network (staff), Partner, Advertiser | Run reports, read the report catalogue and anomaly insights |
entities:read | Network (staff), Partner, Advertiser | Read offers, partners, advertisers, smartlinks, caps, approvals, notifications and postbacks |
logs:read | Network (staff), Partner, Advertiser | Search conversion and click logs and disputes |
billing:read | Network (staff), Partner, Advertiser | Read statements, invoices, earnings and balance |
fraud:read | Network (staff) | Read fraud cases |
offers:write | Network (staff), Partner | Pause and resume offers (network); apply to offers (partner) |
approvals:write | Network (staff) | Approve or reject partner applications |
conversions:write | Network (staff), Advertiser | Approve or reject conversions (network); dispute conversions (advertiser) |
links:write | Network (staff), Partner | Create tracking links |
postbacks:write | Partner | Send test postbacks |
Advertiser tools
| Tool | Scope | Kind | What it does |
|---|---|---|---|
run_report | reports:read | read-only | Run the unified report builder query over a date range: group by dimensions, pick metrics, filter, compare with the previous period or year, sort and limit. Keys come from report_catalog. Time dimensions: hour, day, week, month. Returns one object per row, totals and the reporting currency. With tree it drills down level by level (offer → partner → sub1 …). Money is in the tenant currency unless currency is set. |
report_catalog | reports:read | read-only | List the dimension and metric keys run_report accepts for this account (labels, types, groups). |
list_offers | entities:read | read-only | List or search offers visible to this account (network: all offers; partner: the marketplace and offers you run; advertiser: your offers). |
get_offer | entities:read | read-only | One offer with its details (payouts/goals/caps as this account may see them). |
search_conversions | logs:read | read-only | Search the conversion log by id, click id, transaction id, offer or status over a time range (newest first, cursor paging). |
search_clicks | logs:read | read-only | Search the click log by click id, offer, partner, country, sub id or source over a time range (cursor paging). Partners see their own clicks without IP, user agent, destination URL or device ids. |
list_accounts | entities:read | read-only | The partner or advertiser accounts you belong to in this network and which one this token acts for. A token is bound to the account it was created in: to work on another account, switch accounts in the portal and create a token there. |
caps_status | entities:read | read-only | Current cap usage per cap (limit, used, remaining, period) so you can see what is close to or at its cap. |
list_notifications | entities:read | read-only | Recent in-app notifications and messages for this account. |
anomaly_insights | reports:read | read-only | Statistically unusual changes (drops, spikes) in clicks, conversions, CR and money over the last days, with the dimension that moved. |
dispute_conversion | conversions:write | write, needs confirm: true | Ask to change one of your conversions' status (e.g. reject a fraudulent or returned order). Depending on the network's policy this opens a dispute or applies at once. Requires confirm: true. |
list_disputes | logs:read | read-only | Your conversion disputes and their outcome. |
list_invoices | billing:read | read-only | Your invoices (period, amount, due date, status). |
billing_balance | billing:read | read-only | Your prepaid balance / credit, open invoices and amounts due. |
run_report (advertiser)
Run a performance report.
| Argument | Type | Required | Description |
|---|---|---|---|
compare | string: none, previous_period, previous_year | Compare with an earlier period | |
currency | string | ISO 4217 currency to convert money into (default: tenant currency) | |
cursor | string | next_cursor of the previous page | |
dimensions | array | Group-by keys, e.g. ["offer"] or ["day","country"]; empty for totals | |
filters | array | Dimension filters | |
from | string | yes | Start date YYYY-MM-DD (inclusive, tenant reporting timezone) |
limit | integer (1–1000) | Max rows (default 100) | |
metrics | array | yes | Metric keys, e.g. ["clicks","conversions","payout"] |
sort | string | Metric or dimension key to sort by; prefix - for descending (e.g. -conversions) | |
timezone | string | IANA timezone for date bucketing (default: tenant reporting timezone) | |
to | string | yes | End date YYYY-MM-DD (inclusive) |
tree | object | Tree mode (drill-down): nested levels instead of flat rows. Returns the focused node (totals) and its children (rows, pre-order) with has_children/child_count; drill by repeating the call with path extended by a child's path. |
report_catalog (advertiser)
Report catalogue.
| Argument | Type | Required | Description |
|---|---|---|---|
group | string | Only metrics of this group (optional) |
list_offers (advertiser)
List offers.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Name search text | |
status | string | Status filter (network/advertiser: active, paused, …; partner: approved, pending, available) |
get_offer (advertiser)
Get offer.
| Argument | Type | Required | Description |
|---|---|---|---|
offer_id | string | yes | Offer id |
search_conversions (advertiser)
Search conversions.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
conversion_id | string | Exact conversion id | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
status | string | Exact status | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) | |
txn_id | string | Exact txn id |
search_clicks (advertiser)
Search clicks.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
country | string | Exact country | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
source | string | Exact source | |
sub1 | string | Exact sub1 | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) |
list_accounts (advertiser)
My accounts.
No arguments.
caps_status (advertiser)
Caps status.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) |
list_notifications (advertiser)
Notifications.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) |
anomaly_insights (advertiser)
Anomaly insights.
| Argument | Type | Required | Description |
|---|---|---|---|
days | integer (1–90) | Days to scan (default 7) | |
limit | integer (1–100) | Max insights (default 20) |
dispute_conversion (advertiser)
Dispute a conversion.
| Argument | Type | Required | Description |
|---|---|---|---|
confirm | boolean | Must be true: this action changes live data. Ask the user first, then repeat the call with confirm: true. | |
conversion_id | string | yes | Conversion id |
note | string | Free-text note for the network | |
reason | string: valid, duplicate, fraud, returned, cancelled_order, test, other | yes | Reason code |
status | string: approved, rejected, cancelled | yes | Requested status |
list_disputes (advertiser)
My disputes.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
list_invoices (advertiser)
My invoices.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
billing_balance (advertiser)
Balance and billing summary.
No arguments.
Network (staff) tools
| Tool | Scope | Kind | What it does |
|---|---|---|---|
run_report | reports:read | read-only | Run the unified report builder query over a date range: group by dimensions, pick metrics, filter, compare with the previous period or year, sort and limit. Keys come from report_catalog. Time dimensions: hour, day, week, month. Returns one object per row, totals and the reporting currency. With tree it drills down level by level (offer → partner → sub1 …). Money is in the tenant currency unless currency is set. |
report_catalog | reports:read | read-only | List the dimension and metric keys run_report accepts for this account (labels, types, groups). |
list_offers | entities:read | read-only | List or search offers visible to this account (network: all offers; partner: the marketplace and offers you run; advertiser: your offers). |
get_offer | entities:read | read-only | One offer with its details (payouts/goals/caps as this account may see them). |
search_conversions | logs:read | read-only | Search the conversion log by id, click id, transaction id, offer or status over a time range (newest first, cursor paging). |
search_clicks | logs:read | read-only | Search the click log by click id, offer, partner, country, sub id or source over a time range (cursor paging). Partners see their own clicks without IP, user agent, destination URL or device ids. |
list_smartlinks | entities:read | read-only | Smartlinks (one link that routes each click to the best offer). Partners see the smartlinks they may run; get a link with create_tracking_link and smartlink_id. |
caps_status | entities:read | read-only | Current cap usage per cap (limit, used, remaining, period) so you can see what is close to or at its cap. |
list_notifications | entities:read | read-only | Recent in-app notifications and messages for this account. |
anomaly_insights | reports:read | read-only | Statistically unusual changes (drops, spikes) in clicks, conversions, CR and money over the last days, with the dimension that moved. |
list_partners | entities:read | read-only | Partners (affiliates) with status, manager and tier. |
get_partner | entities:read | read-only | One partner with profile, status, tier and settings. |
list_advertisers | entities:read | read-only | Advertisers with status and manager. |
get_advertiser | entities:read | read-only | One advertiser with profile and settings. |
approvals_queue | entities:read | read-only | Partner applications to offers waiting for a decision (status pending by default). |
list_fraud_cases | fraud:read | read-only | Fraud investigation cases (kind, severity, score, partner, offer, status). |
list_billing_statements | billing:read | read-only | Partner payout statements (period, partner, amount, status). |
list_advertiser_invoices | billing:read | read-only | Advertiser invoices (period, amount, due date, paid status). |
list_smartlinks | entities:read | read-only | Smartlinks (offer rotators) with status and routing mode. |
decide_partner_application | approvals:write | write, needs confirm: true | Approve or reject a partner's application to run an offer. Requires confirm: true. |
set_conversion_status | conversions:write | write, needs confirm: true | Change a conversion's status (approve, reject, set pending). Fires partner postbacks per the offer settings. Requires the approve-conversions grant and confirm: true. |
set_offer_status | offers:write | write, needs confirm: true | Pause (stop traffic) or resume (activate) an offer. Requires confirm: true. |
create_tracking_link | links:write | write | Build a tracking link for an offer or a smartlink with sub ids, a deep link, a landing page or creative. The link records clicks through the tracking domain. |
run_report (network)
Run a performance report.
| Argument | Type | Required | Description |
|---|---|---|---|
compare | string: none, previous_period, previous_year | Compare with an earlier period | |
currency | string | ISO 4217 currency to convert money into (default: tenant currency) | |
cursor | string | next_cursor of the previous page | |
dimensions | array | Group-by keys, e.g. ["offer"] or ["day","country"]; empty for totals | |
filters | array | Dimension filters | |
from | string | yes | Start date YYYY-MM-DD (inclusive, tenant reporting timezone) |
limit | integer (1–1000) | Max rows (default 100) | |
metrics | array | yes | Metric keys, e.g. ["clicks","conversions","payout"] |
sort | string | Metric or dimension key to sort by; prefix - for descending (e.g. -conversions) | |
timezone | string | IANA timezone for date bucketing (default: tenant reporting timezone) | |
to | string | yes | End date YYYY-MM-DD (inclusive) |
tree | object | Tree mode (drill-down): nested levels instead of flat rows. Returns the focused node (totals) and its children (rows, pre-order) with has_children/child_count; drill by repeating the call with path extended by a child's path. |
report_catalog (network)
Report catalogue.
| Argument | Type | Required | Description |
|---|---|---|---|
group | string | Only metrics of this group (optional) |
list_offers (network)
List offers.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Name search text | |
status | string | Status filter (network/advertiser: active, paused, …; partner: approved, pending, available) |
get_offer (network)
Get offer.
| Argument | Type | Required | Description |
|---|---|---|---|
offer_id | string | yes | Offer id |
search_conversions (network)
Search conversions.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
conversion_id | string | Exact conversion id | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
status | string | Exact status | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) | |
txn_id | string | Exact txn id |
search_clicks (network)
Search clicks.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
country | string | Exact country | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
source | string | Exact source | |
sub1 | string | Exact sub1 | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) |
list_smartlinks (network)
List smartlinks.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) |
caps_status (network)
Caps status.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) |
list_notifications (network)
Notifications.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) |
anomaly_insights (network)
Anomaly insights.
| Argument | Type | Required | Description |
|---|---|---|---|
days | integer (1–90) | Days to scan (default 7) | |
limit | integer (1–100) | Max insights (default 20) |
list_partners (network)
List partners.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
get_partner (network)
Get partner.
| Argument | Type | Required | Description |
|---|---|---|---|
partner_id | string | yes | partner id |
list_advertisers (network)
List advertisers.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
get_advertiser (network)
Get advertiser.
| Argument | Type | Required | Description |
|---|---|---|---|
advertiser_id | string | yes | advertiser id |
approvals_queue (network)
Approvals queue.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
status | string: pending, approved, rejected | Application status (default pending) |
list_fraud_cases (network)
Fraud cases.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
list_billing_statements (network)
Partner statements.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
list_advertiser_invoices (network)
Advertiser invoices.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
list_smartlinks (network)
List smartlinks.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
decide_partner_application (network)
Approve or reject an application.
| Argument | Type | Required | Description |
|---|---|---|---|
application_id | string | yes | Partner application id (from approvals_queue) |
confirm | boolean | Must be true: this action changes live data. Ask the user first, then repeat the call with confirm: true. | |
decision | string: approved, rejected | yes | Decision |
reason | string | Reason shown to the partner (optional) |
set_conversion_status (network)
Approve or reject a conversion.
| Argument | Type | Required | Description |
|---|---|---|---|
confirm | boolean | Must be true: this action changes live data. Ask the user first, then repeat the call with confirm: true. | |
conversion_id | string | yes | Conversion id |
reason | string | Reason (stored with the status change) | |
status | string: approved, rejected, pending | yes | New status |
set_offer_status (network)
Pause or resume an offer.
| Argument | Type | Required | Description |
|---|---|---|---|
confirm | boolean | Must be true: this action changes live data. Ask the user first, then repeat the call with confirm: true. | |
offer_id | string | yes | Offer id |
status | string: active, paused | yes | New status |
create_tracking_link (network)
Create a tracking link.
| Argument | Type | Required | Description |
|---|---|---|---|
creative_id | string | Creative id | |
deep_link | string | Landing URL override (deep link), if the offer allows it | |
landing_page_id | string | Landing page id | |
offer_id | string | Offer id (one of offer_id / smartlink_id) | |
partner_id | string | Partner the link is for (network only; partners get their own link) | |
smartlink_id | string | Smartlink id (partners: one from list_smartlinks) | |
sub_ids | object | sub1..sub10 and source values |
Partner tools
| Tool | Scope | Kind | What it does |
|---|---|---|---|
run_report | reports:read | read-only | Run the unified report builder query over a date range: group by dimensions, pick metrics, filter, compare with the previous period or year, sort and limit. Keys come from report_catalog. Time dimensions: hour, day, week, month. Returns one object per row, totals and the reporting currency. With tree it drills down level by level (offer → partner → sub1 …). Money is in the tenant currency unless currency is set. |
report_catalog | reports:read | read-only | List the dimension and metric keys run_report accepts for this account (labels, types, groups). |
list_offers | entities:read | read-only | List or search offers visible to this account (network: all offers; partner: the marketplace and offers you run; advertiser: your offers). |
get_offer | entities:read | read-only | One offer with its details (payouts/goals/caps as this account may see them). |
search_conversions | logs:read | read-only | Search the conversion log by id, click id, transaction id, offer or status over a time range (newest first, cursor paging). |
search_clicks | logs:read | read-only | Search the click log by click id, offer, partner, country, sub id or source over a time range (cursor paging). Partners see their own clicks without IP, user agent, destination URL or device ids. |
list_smartlinks | entities:read | read-only | Smartlinks (one link that routes each click to the best offer). Partners see the smartlinks they may run; get a link with create_tracking_link and smartlink_id. |
list_accounts | entities:read | read-only | The partner or advertiser accounts you belong to in this network and which one this token acts for. A token is bound to the account it was created in: to work on another account, switch accounts in the portal and create a token there. |
list_notifications | entities:read | read-only | Recent in-app notifications and messages for this account. |
anomaly_insights | reports:read | read-only | Statistically unusual changes (drops, spikes) in clicks, conversions, CR and money over the last days, with the dimension that moved. |
create_tracking_link | links:write | write | Build a tracking link for an offer or a smartlink with sub ids, a deep link, a landing page or creative. The link records clicks through the tracking domain. |
apply_to_offer | offers:write | write | Apply to run an offer that needs approval (or join it when it is public). Returns the application status. |
my_earnings | billing:read | read-only | Your payout statements (period, amount, currency, status, paid date). |
list_postbacks | entities:read | read-only | Your postback (pixel) configurations. |
test_postback | postbacks:write | write | Fire one of your postbacks with test values and return the URL called and the response. |
run_report (partner)
Run a performance report.
| Argument | Type | Required | Description |
|---|---|---|---|
compare | string: none, previous_period, previous_year | Compare with an earlier period | |
currency | string | ISO 4217 currency to convert money into (default: tenant currency) | |
cursor | string | next_cursor of the previous page | |
dimensions | array | Group-by keys, e.g. ["offer"] or ["day","country"]; empty for totals | |
filters | array | Dimension filters | |
from | string | yes | Start date YYYY-MM-DD (inclusive, tenant reporting timezone) |
limit | integer (1–1000) | Max rows (default 100) | |
metrics | array | yes | Metric keys, e.g. ["clicks","conversions","payout"] |
sort | string | Metric or dimension key to sort by; prefix - for descending (e.g. -conversions) | |
timezone | string | IANA timezone for date bucketing (default: tenant reporting timezone) | |
to | string | yes | End date YYYY-MM-DD (inclusive) |
tree | object | Tree mode (drill-down): nested levels instead of flat rows. Returns the focused node (totals) and its children (rows, pre-order) with has_children/child_count; drill by repeating the call with path extended by a child's path. |
report_catalog (partner)
Report catalogue.
| Argument | Type | Required | Description |
|---|---|---|---|
group | string | Only metrics of this group (optional) |
list_offers (partner)
List offers.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Name search text | |
status | string | Status filter (network/advertiser: active, paused, …; partner: approved, pending, available) |
get_offer (partner)
Get offer.
| Argument | Type | Required | Description |
|---|---|---|---|
offer_id | string | yes | Offer id |
search_conversions (partner)
Search conversions.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
conversion_id | string | Exact conversion id | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
status | string | Exact status | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) | |
txn_id | string | Exact txn id |
search_clicks (partner)
Search clicks.
| Argument | Type | Required | Description |
|---|---|---|---|
click_id | string | Exact click id | |
country | string | Exact country | |
cursor | string | next_cursor of the previous page | |
from | string | Start (YYYY-MM-DD or RFC 3339; default 7 days before to) | |
limit | integer (1–200) | Max rows (default 50) | |
offer_id | string | Exact offer id | |
source | string | Exact source | |
sub1 | string | Exact sub1 | |
to | string | End (YYYY-MM-DD or RFC 3339; default now) |
list_smartlinks (partner)
List smartlinks.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) |
list_accounts (partner)
My accounts.
No arguments.
list_notifications (partner)
Notifications.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) |
anomaly_insights (partner)
Anomaly insights.
| Argument | Type | Required | Description |
|---|---|---|---|
days | integer (1–90) | Days to scan (default 7) | |
limit | integer (1–100) | Max insights (default 20) |
create_tracking_link (partner)
Create a tracking link.
| Argument | Type | Required | Description |
|---|---|---|---|
creative_id | string | Creative id | |
deep_link | string | Landing URL override (deep link), if the offer allows it | |
landing_page_id | string | Landing page id | |
offer_id | string | Offer id (one of offer_id / smartlink_id) | |
partner_id | string | Partner the link is for (network only; partners get their own link) | |
smartlink_id | string | Smartlink id (partners: one from list_smartlinks) | |
sub_ids | object | sub1..sub10 and source values |
apply_to_offer (partner)
Apply to an offer.
| Argument | Type | Required | Description |
|---|---|---|---|
answers | object | Answers to the offer's questionnaire, if it has one | |
offer_id | string | yes | Offer id |
my_earnings (partner)
My earnings and statements.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
list_postbacks (partner)
My postbacks.
| Argument | Type | Required | Description |
|---|---|---|---|
page | integer (1–100000) | Page number (1-based, default 1) | |
page_size | integer (1–100) | Rows per page (default 25, max 100) | |
query | string | Search text (optional) | |
status | string | Status filter (optional) |
test_postback (partner)
Test a postback.
| Argument | Type | Required | Description |
|---|---|---|---|
postback_id | string | yes | Postback id (from list_postbacks) |
Resources
| URI | Scope |
|---|---|
metrixed://reports/catalog | reports:read |
metrixed://offers/{id} | entities:read |
Prompts
| Prompt | Audiences | Description |
|---|---|---|
weekly_performance_review | Network (staff), Partner, Advertiser | Last 7 days vs the previous 7: what moved, top and bottom offers, actions |
why_did_metric_drop | Network (staff), Partner, Advertiser | Find where a metric fell and the likely cause |
find_fraud | Network (staff) | Scan for suspicious partners, sub ids and conversions |
partner_earnings_summary | Network (staff), Partner | Earnings this month vs last, by offer, with statements |