Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
calculate-total
cURL
curl --request POST \
  --url http://api/v1/projects/{projectUuid}/calculate-total \
  --header 'Content-Type: application/json' \
  --data '
{
  "parameters": {},
  "explore": "<string>",
  "metricQuery": {
    "metricOverrides": {},
    "timezone": "<string>",
    "metadata": {
      "hasADateDimension": {
        "name": "<string>",
        "label": "<string>",
        "table": "<string>"
      }
    },
    "dateZoom": {
      "xAxisFieldId": "<string>",
      "granularity": "Day"
    },
    "customDimensions": [
      {
        "id": "<string>",
        "name": "<string>",
        "table": "<string>",
        "type": "bin",
        "dimensionId": "<string>",
        "binType": "fixed_number",
        "binNumber": 123,
        "binWidth": 123,
        "customRange": [
          {
            "to": 123,
            "from": 123
          }
        ]
      }
    ],
    "csvLimit": 123,
    "additionalMetrics": [
      {
        "label": "<string>",
        "type": "percentile",
        "description": "<string>",
        "sql": "<string>",
        "hidden": true,
        "round": 123,
        "compact": "thousands",
        "format": "km",
        "table": "<string>",
        "name": "<string>",
        "index": 123,
        "filters": [
          {
            "values": [
              "<any>"
            ],
            "operator": "isNull",
            "id": "<string>",
            "target": {
              "fieldRef": "<string>"
            },
            "settings": "<any>",
            "disabled": true,
            "required": true
          }
        ],
        "baseDimensionName": "<string>",
        "uuid": "<string>",
        "percentile": 123,
        "formatOptions": {
          "type": "default",
          "round": 123,
          "separator": "default",
          "currency": "<string>",
          "compact": "thousands",
          "prefix": "<string>",
          "suffix": "<string>",
          "timeInterval": "RAW",
          "custom": "<string>"
        }
      }
    ],
    "tableCalculations": [
      {
        "type": "number",
        "format": {
          "type": "default",
          "round": 123,
          "separator": "default",
          "currency": "<string>",
          "compact": "thousands",
          "prefix": "<string>",
          "suffix": "<string>",
          "timeInterval": "RAW",
          "custom": "<string>"
        },
        "displayName": "<string>",
        "name": "<string>",
        "index": 123,
        "sql": "<string>"
      }
    ],
    "limit": 123,
    "sorts": [
      {
        "nullsFirst": true,
        "descending": true,
        "fieldId": "<string>"
      }
    ],
    "filters": {
      "tableCalculations": "<any>",
      "metrics": "<any>",
      "dimensions": "<any>"
    },
    "metrics": [
      "<string>"
    ],
    "dimensions": [
      "<string>"
    ],
    "exploreName": "<string>"
  }
}
'
{
  "results": {},
  "status": "ok"
}

Path Parameters

​
projectUuid
string
required

The uuid of the project to get charts for

Body

application/json

The metric query to calculate totals for

​
explore
string
required
​
metricQuery
object
required
​
parameters
object

Construct a type with a set of properties K of type T

Response

Success

​
results
object
required

Construct a type with a set of properties K of type T

​
status
enum<string>
required
Available options:
ok