API reference / Operations by tag

advertisers

Advertisers (the brands or networks that pay for conversions), their billing and portal settings.

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

Operations

POST /advertiser/assistant/chat

Advertiser portal: ask the AI assistant about own offers, conversions, caps, disputes and invoices (no partner payouts); streams Server-Sent Events conversation, text, tool_call, tool_result, done, error

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

Request body (application/json, required): PortalDoc

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

Example 200 response:

{}

GET /advertiser/billing/summary

Advertiser portal: balance, amount owed, credit limit and available credit, outstanding and overdue per currency, spend this and last month

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

curl 'https://api.metrixed.com/v1/advertiser/billing/summary' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /advertiser/caps

Advertiser portal: live usage of the caps on own offers (payout caps hidden; revenue caps shown as spend)

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

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

Example 200 response:

{}

POST /advertiser/clicks/search

Advertiser portal: raw click log of own offers (partner fields only when exposed, ip/user agent only when the tenant allows)

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

Request body (application/json, required): LogSearchRequest

curl -X POST 'https://api.metrixed.com/v1/advertiser/clicks/search' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"from":"1970-01-01T00:00:00.000Z","to":"1970-01-01T00:00:00.000Z","timezone":"","filters":[{}]}'

Example 200 response:

{}

POST /advertiser/conversions/{id}/status

Advertiser portal: approve, reject, cancel or re-open a conversion (applied at once or opened as a dispute per the tenant policy)

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

Request body (application/json, required): AdvertiserStatusChange

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

Example 200 response:

{}

POST /advertiser/conversions/bulk-status

Advertiser portal: status change for up to 500 conversions

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

Request body (application/json, required): AdvertiserBulkStatusChange

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

Example 200 response:

{}

GET /advertiser/disputes

Advertiser portal: own conversion disputes (filter status, conversion_id) with counts per status Advertiser portal: own conversion disputes (filter status, conversion_id) with counts per status. WP-67: paged; q matches conversion / txn id or offer; counts per status.

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

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

Example 200 response:

{}

POST /advertiser/disputes/{id}/withdraw

Advertiser portal: withdraw an open dispute

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

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

Example 200 response:

{
  "ok": false
}

GET /advertiser/invoices/{id}

Advertiser portal: invoice detail (lines, payments, paid, outstanding, pay state, payment link)

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

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

Example 200 response:

{}

GET /advertiser/invoices/{id}/pdf

Advertiser portal: invoice as PDF (application/pdf)

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

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

Example 200 response:

{}

GET /advertiser/login-history

Advertiser portal: recent sign-ins (all users for admins, own otherwise) Advertiser portal: recent sign-ins (all users for admins, own otherwise). WP-71: paged with page/page_size (page.total over the whole match); unpaged returns the previous bound with total and capped/cap.

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

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

Example 200 response:

{}

GET /advertiser/me

Advertiser profile

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

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

Example 200 response:

{
  "external_ref": ""
}

GET /advertiser/mmp-templates

Advertiser portal: own postback, reversal and MMP setup

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

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

Example 200 response:

{
  "tracking_base": "",
  "token_secured": false,
  "postback_url": "",
  "reversal_url": ""
}

GET /advertiser/notification-prefs

Advertiser portal: own notification preferences per kind (in_app, email)

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

curl 'https://api.metrixed.com/v1/advertiser/notification-prefs' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

PUT /advertiser/notification-prefs

Advertiser portal: update own notification preferences

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

Request body (application/json, required): NotificationPrefs

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

Example 200 response:

{}

GET /advertiser/notifications

Advertiser portal: notifications for the account and the user (filter=unread, kind, cursor)

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

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

Example 200 response:

{}

POST /advertiser/notifications/read

Advertiser portal: mark notifications read (ids[] or all; unread=true marks unread)

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

Request body (application/json, required): NotificationRead

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

Example 200 response:

{
  "ok": false
}

GET /advertiser/notifications/summary

Advertiser portal: unread notification count

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

curl 'https://api.metrixed.com/v1/advertiser/notifications/summary' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /advertiser/offers

Advertiser offers Advertiser offers. WP-71: paged with page/page_size (page.total over the whole match); unpaged returns the previous bound with total and capped/cap.

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

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

Example 200 response:

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

GET /advertiser/offers/{id}

Advertiser portal: offer detail with goals and what each costs, caps and remaining, creatives, landing pages and tracking setup

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

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

Example 200 response:

{}

GET /advertiser/onboarding

Advertiser portal: first-login checklist (profile, prepaid top-up, first postback)

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

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

Example 200 response:

{}

POST /advertiser/onboarding/dismiss

Advertiser portal: hide the first-login checklist

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

Request body (application/json, required): PortalDoc

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

Example 200 response:

{}

GET /advertiser/payments

Advertiser portal: payment history (invoice payments and other ledger credits) Advertiser portal: payment history (invoice payments and other ledger credits). WP-67: naturally small; returns at most 500 rows and capped: true when that cap is hit.

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

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

Example 200 response:

{}

GET /advertiser/permissions

Advertiser portal: own role, permissions, role matrix and the tenant's conversion-action policy (dispute|direct|off)

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

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

Example 200 response:

{}

POST /advertiser/postback-test

Advertiser portal: dry-run an inbound postback for an own offer (nothing is recorded)

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

Request body (application/json, required): ConversionCreate

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

{}

POST /advertiser/postback-token/rotate

Advertiser portal: rotate the postback security token (old token stops working)

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

curl -X POST 'https://api.metrixed.com/v1/advertiser/postback-token/rotate' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /advertiser/profile

Advertiser portal: company profile, contact, billing details and account manager

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

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

Example 200 response:

{}

PATCH /advertiser/profile

Advertiser portal: update company, reporting time zone, contact and billing details (account permission)

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

Request body (application/json, required): AdvertiserProfile

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

Example 200 response:

{}

GET /advertiser/reconciliation/jobs

Advertiser portal: reconciliation upload history with result counts Advertiser portal: reconciliation upload history with result counts. WP-71: paged with page/page_size (page.total over the whole match); unpaged returns the previous bound with total and capped/cap.

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

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

Example 200 response:

{}

GET /advertiser/reconciliation/jobs/{id}

Advertiser portal: one reconciliation upload with per-row results

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

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

Example 200 response:

{}

GET /advertiser/reports/catalog

Advertiser portal: report catalogue (only what the advertiser may see)

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

curl 'https://api.metrixed.com/v1/advertiser/reports/catalog' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{
  "principal": "network",
  "endpoint": "",
  "dimensions": [
    {}
  ],
  "metrics": [
    {}
  ]
}

POST /advertiser/reports/export

Advertiser portal: async report export (CSV/XLSX of the whole result)

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

Request body (application/json, required): ExportRequest

curl -X POST 'https://api.metrixed.com/v1/advertiser/reports/export' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"query":{"from":"","to":""},"log":{},"format":"csv","notify_email":""}'

Example 202 response:

{
  "external_ref": ""
}

GET /advertiser/reports/export/{id}

Advertiser portal: export job status (own exports only)

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

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

Example 200 response:

{
  "job_id": "",
  "status": "queued",
  "progress": 0,
  "kind": ""
}

GET /advertiser/reports/saved

Advertiser portal: saved reports (own and team)

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

curl 'https://api.metrixed.com/v1/advertiser/reports/saved' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

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

POST /advertiser/reports/saved

Advertiser portal: save a report

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

Request body (application/json, required): SavedReport

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

Example 201 response:

{
  "external_ref": ""
}

GET /advertiser/reports/saved/{id}

Advertiser portal: get a saved report

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

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

Example 200 response:

{
  "external_ref": ""
}

PATCH /advertiser/reports/saved/{id}

Advertiser portal: update a saved report

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

Request body (application/json, required): SavedReport

curl -X PATCH 'https://api.metrixed.com/v1/advertiser/reports/saved/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"external_ref":""}'

Example 200 response:

{
  "external_ref": ""
}

DELETE /advertiser/reports/saved/{id}

Advertiser portal: delete a saved report

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

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

Example 204 response:

{
  "ok": false
}

GET /advertiser/reports/schedules

Advertiser portal: scheduled reports

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

curl 'https://api.metrixed.com/v1/advertiser/reports/schedules' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

POST /advertiser/reports/schedules

Advertiser portal: schedule a saved report (or the default performance report) by email

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

Request body (application/json, required): AdvertiserSchedule

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

Example 201 response:

{}

PATCH /advertiser/reports/schedules/{id}

Advertiser portal: update or pause a scheduled report

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

Request body (application/json, required): AdvertiserSchedule

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

Example 200 response:

{}

DELETE /advertiser/reports/schedules/{id}

Advertiser portal: delete a scheduled report

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

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

Example 204 response:

{
  "ok": false
}

POST /advertiser/reports/schedules/{id}/run

Advertiser portal: run a scheduled report now (within a minute)

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

curl -X POST 'https://api.metrixed.com/v1/advertiser/reports/schedules/<id>/run' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 202 response:

{
  "ok": false
}

GET /advertiser/security

Advertiser portal: portal IP allowlist, caller IP and MFA coverage

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

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

Example 200 response:

{}

PUT /advertiser/security

Advertiser portal: set the portal IP allowlist (IPs/CIDRs; must include the caller's IP; empty = everyone)

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

Request body (application/json, required): AdvertiserSecurity

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

Example 200 response:

{}

GET /advertiser/statement

Advertiser portal: statement of account (from, to, currency): opening balance, daily charges and payments with running balance

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

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

Example 200 response:

{}

GET /advertiser/statement/export

Advertiser portal: statement of account as CSV or PDF (format=csv|pdf)

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

curl 'https://api.metrixed.com/v1/advertiser/statement/export' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /advertiser/topups

Advertiser portal: top-up requests and credited top-ups

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

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

Example 200 response:

{}

GET /advertiser/users

Advertiser portal: own team members and pending invitations

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

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

Example 200 response:

{}

POST /advertiser/users

Advertiser portal: invite a team member

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

Request body (application/json, required): PortalDoc

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

Example 201 response:

{}

PATCH /advertiser/users/{id}

Advertiser portal: change a team member's role or disable / re-enable them

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

Request body (application/json, required): TeamMemberPatch

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

Example 200 response:

{
  "ok": false
}

DELETE /advertiser/users/invitations/{id}

Advertiser portal: revoke a pending invitation

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

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

Example 204 response:

{
  "ok": false
}

POST /advertiser/users/invitations/{id}/resend

Advertiser portal: resend a pending invitation (new link, 7 more days)

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

curl -X POST 'https://api.metrixed.com/v1/advertiser/users/invitations/<id>/resend' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /advertisers

List Advertisers

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

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

Example 200 response:

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

POST /advertisers

Create Advertiser

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

Request body (application/json, required): AdvertiserCreate

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

Example 201 response:

{
  "external_ref": ""
}

GET /advertisers/{id}

Get Advertiser

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

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

Example 200 response:

{
  "external_ref": ""
}

PATCH /advertisers/{id}

Update Advertiser

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

Request body (application/json, required): AdvertiserUpdate

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

Example 200 response:

{
  "external_ref": ""
}

DELETE /advertisers/{id}

Delete Advertiser

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

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

Example 204 response:

{
  "ok": false
}

GET /advertisers/{id}/postback-setup

Postback setup of one advertiser: tracking origin, postback and reversal URL templates with its token, MMP templates

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

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

Example 200 response:

{
  "tracking_base": "",
  "token_secured": false,
  "postback_url": "",
  "reversal_url": ""
}

GET /advertisers/{id}/users

Advertiser users

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

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

Example 200 response:

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

POST /advertisers/{id}/users

Create advertiser user

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

Request body (application/json, required): UserCreate

curl -X POST 'https://api.metrixed.com/v1/advertisers/<id>/users' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"email":"user@example.com","name":""}'

Example 201 response:

{
  "external_ref": ""
}

POST /advertisers/bulk/apply

Bulk edit apply

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

Request body (application/json, required): BulkPatch

curl -X POST 'https://api.metrixed.com/v1/advertisers/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 /advertisers/bulk/delete

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

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

Request body (application/json, required): BulkDeleteRequest

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

Example 200 response:

{}

POST /advertisers/bulk/preview

Bulk edit preview

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

Request body (application/json, required): BulkPatch

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

Search Advertisers (advanced)

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

Request body (application/json, required): SearchRequest

curl -X POST 'https://api.metrixed.com/v1/advertisers/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 /mmp-templates

MMP postback templates (AppsFlyer, Adjust, Branch, Singular, Kochava): inbound postback URL for the MMP's partner setup and the outbound mmp: S2S preset; advertiser_id renders the URL with that advertiser's token

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

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

Example 200 response:

{
  "data": [
    {}
  ]
}