API reference / Operations by tag

tenants

The current tenant: profile, usage and the config version that tracking nodes cache.

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

Operations

Method	Path	Summary
GET	`/tenant`	Current tenant
PATCH	`/tenant`	Update tenant
GET	`/tenant/config-version`	Current config version (edge snapshot)
GET	`/tenant/usage`	Plan usage meters

`GET /tenant`

Current tenant

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

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /tenant`

Update tenant

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

Request body (application/json, required): TenantUpdate

Field	Type	Flags	Description
`slug`	string
`name`	string
`plan`	string
`status`	enum: `trial`, `active`, `suspended`, `closed`
`default_currency`	string
`reporting_timezone`	string
`caps_timezone`	string
`locale`	string
`data_region`	string
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`branding`	object (free-form)
`portal_domains`	object (free-form)
`terms_and_conditions`	string
`signup_questions_partner`	array of object (free-form)
`signup_questions_advertiser`	array of object (free-form)
`partner_signup_mode`	string
`partner_visibility_defaults`	object (free-form)
`feature_flags`	object (free-form)
`retention_days_raw`	integer
`retention_days_aggregates`	integer
`api_rate_limits`	object (free-form)
`settings`	object (free-form)

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/tenant' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"slug":"","name":"","plan":"","status":"trial"}'

Example 200 response:

json

{
  "external_ref": ""
}

`GET /tenant/config-version`

Current config version (edge snapshot)

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

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

bash

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

Example 200 response:

json

{
  "ok": false
}

`GET /tenant/usage`

Plan usage meters

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

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

bash

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

Example 200 response:

json

{
  "period": "",
  "meters": [
    {}
  ],
  "limits": {}
}