Insights
Get list of all messages passing through your flows and usage information (telemetry).
Last updated
Get list of all messages passing through your flows and usage information (telemetry).
Last updated
GET
https://api.appmixer.com/logs
Get logs for a single flow or list of flows or all user's flows. Filtering and sorting supported. Logs contain data messages getting into component's input port(s) and messages sent to component's output port(s). They also contain any errors that occurred during flow run or while trying to start/stop a flow.
curl "https://api.appmixer.com/logs?from=0&size=30&sort=@timestamp:desc&query=@timestamp:[2019-03-04+TO+2019-03-08]&flowId=9c4673d7-a550-45a2-91c1-ad057fac0385" -H "Authorization: Bearer [ACCESS_TOKEN]"
curl "https://api.appmixer.com/logs?from=0&size=30&sort=@timestamp:desc&query=@timestamp:[2019-03-04+TO+2019-03-08]" -H "Authorization: Bearer [ACCESS_TOKEN]"
Name | Type | Description |
---|---|---|
GET
https://api.appmixer.com/log/:logIndex/:logId
Get a detail of a log. Log detail gives you information on the actual data of the message between two components.
curl "https://api.appmixer.com/log/93198d48-e680-49bb-855c-58c2c11d1857/appmixer-201804/AWKbQ6Vr9I6rzDWu4NbG" -H "Authorization: Bearer [ACCESS_TOKEN]"
POST
https://api.appmixer.com/logs
This method works the same as its /GET counterpart, but it also allows to get aggregations within the matched data, by passing a request body specifying desired aggregations.
GET
https://api.appmixer.com/telemetry
Get usage information.
curl "https://api.appmixer.com/telemetry?from=2018-03-17&to=2018-04-17" -H "Authorization: Bearer [ACCESS_TOKEN]"
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
portType
string
string: in
or out
. Or it can be array portType=in&portType=out
. Used to filter only input messages or output messages. in and out
by default.
flowId
string
The flow ID to filter on. This parameter can be used multiple times to filter on more flows. If not present, it will return logs for all user's flows (even flows that are being shared with signed in user).
exclude
string
A comma separated field names to exclude from the log objects returned.
query
string
Query string. Uses the Lucene query syntax: https://lucene.apache.org/core/2_9_4/queryparsersyntax.html
sort
string
A parameter to sort the result. Optionally followed by ":desc" to change the order. asc
by default.
size
number
Maximum number of logs returned. Useful for pagination. 50 records by default.
from
number
Index of the first log returned. Useful for pagination.
logId
string
Log ID. Use the "_id" property of the log object returned from flow logs.
logIndex
string
Log index. Use the "_index" property of the log object returned from flow logs.
flowId
string
The flow ID to filter on. This parameter can be used multiple times to filter on more flows.
exclude
string
A comma separated field names to exclude from the log objects returned.
query
string
Query string. Uses the Lucene query syntax: https://lucene.apache.org/core/2_9_4/queryparsersyntax.html
sort
string
A parameter to sort by. Optionally followed by ":desc" to change the order.
size
number
Maximum number of logs returned. Useful for pagination.
from
number
Index of the first log returned. Useful for pagination.
aggs
object
An object describing the desired aggregations. Uses Elasticsearch aggregation search structure: https://elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html
to
string
To date.
from
string
From date.