Metrics API

PreviousEvents API NextWorkflow API

Last updated 5 months ago

Get Access Token

Generate a access token to use in metrics API requests

POSThttps://metrics-api.userflux.co/metrics/auth/token

Body

clientSecretstring

Example: "{{metricsClientSecret}}"

environmentApiKeystring

Example: "{{metricsApiKey}}"

Response

Successful Response

Body

accessTokenstring

Example: "access token"

tokenTypestring

Example: "Bearer"

Request

const response = await fetch('https://metrics-api.userflux.co/metrics/auth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Run pre-defined query

Run a query against one of your pre-defined metrics

POSThttps://metrics-api.userflux.co/metrics/query/{metric-id}

Authorization

Body

variablesobject

Response

Successful Response

Body

successResponseobject

errorResponseobject

Request

const response = await fetch('https://metrics-api.userflux.co/metrics/query/{metric-id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Run SQL Query

Run a SQL query

POSThttps://metrics-api.userflux.co/metrics/query

Authorization

Body

encodedQuerystring

Example:

"U0VMRUNUIHRpbWVzdGFtcCwgdXNlcklkLCBhbm9ueW1vdXNJZCwgbmFtZSwgdWZQcm9wZXJ0aWVzLnVybFBhdGggYXMgcGFnZVBhdGggCkZST00gZXZlbnRzVGFibGUgCldIRVJFIG5hbWUgPSAnQHtldmVudE5hbWV9JyAKTElNSVQgQHtyb3dMaW1pdH0="

variablesobject

Response

Successful Response

Body

successResponseobject

errorResponseobject

Request

const response = await fetch('https://metrics-api.userflux.co/metrics/query', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
});
const data = await response.json();