API reference / Operations by tag

logs

Click, conversion and postback logs, plus the real-time firehose.

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

Operations

Method	Path	Summary
GET	`/firehose`	SSE event stream (staff). Query: types=conversion,postback.result (exact or family prefix). Reconnect with Last-Event-ID to replay missed events (~2000 per tenant buffered).
GET	`/firehose/sinks`	List FirehoseSinks
POST	`/firehose/sinks`	Create FirehoseSink
GET	`/firehose/sinks/{id}`	Get FirehoseSink
PATCH	`/firehose/sinks/{id}`	Update FirehoseSink
DELETE	`/firehose/sinks/{id}`	Delete FirehoseSink
POST	`/firehose/sinks/bulk/apply`	Bulk edit apply
POST	`/firehose/sinks/bulk/preview`	Bulk edit preview
POST	`/firehose/sinks/search`	Search FirehoseSinks (advanced)
GET	`/logs/{type}/{id}`	Full record with decision explanation
POST	`/logs/{type}/search`	Search raw logs

`GET /firehose`

SSE event stream (staff). Query: types=conversion,postback.result (exact or family prefix). Reconnect with Last-Event-ID to replay missed events (~2000 per tenant buffered). SSE event stream (staff). Query: types=conversion,postback.result (exact or family prefix). Reconnect with Last-Event-ID to replay missed events (~2000 per tenant buffered)..

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

Parameter	In	Type	Required	Description
`types`	query	string	no
`last_event_id`	query	string	no

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

bash

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

Example 200 response:

json

{
  "ok": false
}

`GET /firehose/sinks`

List FirehoseSinks

Operation getFirehoseSinks. 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 FirehoseSinkList
default	error	application/json Error

bash

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

Example 200 response:

json

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

`POST /firehose/sinks`

Create FirehoseSink

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

Request body (application/json, required): FirehoseSinkCreate

Field	Type	Flags	Description
`name`	string	required
`kind`	enum: `sqs`, `pubsub`, `kafka`, `memory`	required
`config`	object (free-form)		sqs: queue_url, region \| pubsub: project, topic \| kafka: brokers, topic
`types`	array of string
`status`	enum: `active`, `paused`, `disabled`

Status	Description	Body
201	ok	application/json FirehoseSink
default	error	application/json Error

bash

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

Example 201 response:

json

{
  "external_ref": ""
}

`GET /firehose/sinks/{id}`

Get FirehoseSink

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /firehose/sinks/{id}`

Update FirehoseSink

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): FirehoseSinkUpdate

Field	Type	Description
`name`	string
`kind`	enum: `sqs`, `pubsub`, `kafka`, `memory`
`config`	object (free-form)	sqs: queue_url, region \| pubsub: project, topic \| kafka: brokers, topic
`types`	array of string
`status`	enum: `active`, `paused`, `disabled`

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

bash

curl -X PATCH 'https://api.metrixed.com/v1/firehose/sinks/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"","kind":"sqs","config":{},"types":[""]}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /firehose/sinks/{id}`

Delete FirehoseSink

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

Parameter	In	Type	Required	Description
`id`	path	string	yes

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

bash

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

Example 204 response:

json

{
  "ok": false
}

`POST /firehose/sinks/bulk/apply`

Bulk edit apply

Operation postFirehoseSinksBulkApply. 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

bash

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

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /firehose/sinks/bulk/preview`

Bulk edit preview

Operation postFirehoseSinksBulkPreview. 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

bash

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

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /firehose/sinks/search`

Search FirehoseSinks (advanced)

Operation postFirehoseSinksSearch. 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 FirehoseSinkList
default	error	application/json Error

bash

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

json

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

`GET /logs/{type}/{id}`

Full record with decision explanation

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

Parameter	In	Type	Required	Description
`type`	path	string	yes
`id`	path	string	yes

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

bash

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

Example 200 response:

json

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

`POST /logs/{type}/search`

Search raw logs

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

Parameter	In	Type	Required	Description
`type`	path	enum: `clicks`, `impressions`, `conversions`, `events`, `installs`, `postbacks_out`, `postbacks_in`, `fail_traffic`, `fraud`	yes

Request body (application/json, required): LogSearchRequest

Field	Type	Description
`from`	string (date-time)
`to`	string (date-time)
`timezone`	string
`filters`	array of object (free-form)
`search`	object (free-form)	type, value
`fields`	array of string
`limit`	integer
`cursor`	string
`sort`	object (free-form)

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

bash

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

json

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