API reference / Operations by tag

tenant

Operations tagged tenant.

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

Operations

GET /assistant/audit

AI assistant audit log: prompts as typed and the tools called (results are never stored) AI assistant audit log: prompts as typed and the tools called (results are never stored). WP-71: paged with page/page_size (page.total over the whole match); unpaged returns the previous bound with total and capped/cap.

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

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

Example 200 response:

{}

GET /assistant/settings

AI assistant settings: enable flags, monthly token budget, per-user requests per minute

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

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

Example 200 response:

{}

PUT /assistant/settings

Update AI assistant settings

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

Request body (application/json, required): PortalDoc

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

Example 200 response:

{}

GET /notification-preferences

Notification matrix: per event kind, email to the team and/or the partner or advertiser concerned

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

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

Example 200 response:

{}

PUT /notification-preferences

Save the notification matrix (unknown kinds or audiences are rejected)

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

Request body (application/json, required): NotificationPreferencesUpdate

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

Example 200 response:

{}

GET /onboarding

Admin onboarding checklist (tracking domain, offer, partner, first click, first postback) computed from real data, plus sample-data status

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

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

Example 200 response:

{}

POST /onboarding/dismiss

Hide (or with {dismissed:false} show again) the onboarding checklist for the calling user

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

Request body (application/json, required): PortalDoc

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

Example 200 response:

{}

GET /onboarding/sample-data

Sample data status: created records, tracking links and simulated test traffic

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

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

Example 200 response:

{}

POST /onboarding/sample-data

Load sample data: demo advertiser, offers, partners and smartlink plus simulated test clicks/conversions through edge and ingest (excluded from billing and reports)

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

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

Example 202 response:

{}

DELETE /onboarding/sample-data

Remove the sample records (test traffic stays in the logs flagged TEST)

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

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

Example 200 response:

{}

GET /tenant/public

Public: portal branding, signup fields and terms for a portal host (no auth)

Operation getTenantPublic. Auth: none (public endpoint).

curl 'https://api.metrixed.com/v1/tenant/public' \
  -H 'Accept: application/json'

Example 200 response:

{}