---
title: "Every measure that can be asked for, and how it may be cut"
description: "Discovery."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/analytics/every-measure-that-can-be-asked-for"
---
# Every measure that can be asked for, and how it may be cut

> Discovery.

<api-operation method="GET" path="/v1/analytics/measures">
<template v-slot:docs="">

Read this instead of hard-coding a list of metrics: a measure that is not here does not exist, and new ones appear here before anything else announces them.

Each entry says what the number MEANS, whether it is a value at an instant (`kind: stock`) or a sum over a window (`kind: flow`), what unit it is in, which dimensions it may be split by, which grains it may be shown at, and whether a comparison window is meaningful. A client that renders its picker from this payload cannot offer a cut the engine would refuse.

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        list
      </code>
      
      . One of <code>
        list
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The items.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The measure id. Pass it as <code>
        measure
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.name
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The display name.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.description
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      One sentence on what the number means.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.kind
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        stock
      </code>
      
       is a value at the end of a period. <code>
        flow
      </code>
      
       is a sum across a period. One of <code>
        stock
      </code>
      
      , <code>
        flow
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.unit
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The unit of the value. One of <code>
        money
      </code>
      
      , <code>
        count
      </code>
      
      , <code>
        ratio
      </code>
      
      , <code>
        bps
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.aggregate
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      How periods combine. One of <code>
        sum
      </code>
      
      , <code>
        last
      </code>
      
      , <code>
        ratio
      </code>
      
      , <code>
        none
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.dimensions
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      The dimensions you can split by.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.grains
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      The period sizes that the measure supports.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.currency
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        per_currency
      </code>
      
       if the value is money in each currency, <code>
        none
      </code>
      
       otherwise. One of <code>
        per_currency
      </code>
      
      , <code>
        none
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.value_as_of
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Which instant the figure describes. <code>
        computed_at
      </code>
      
       means the live book, with no history. One of <code>
        period_end
      </code>
      
      , <code>
        computed_at
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.supports_compare
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True if the measure accepts <code>
        compare
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.segmentable
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True if the measure accepts <code>
        segment
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      The measure registry
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/analytics/measures" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">

```json [200 OK]
{
  "object": "list",
  "data": [
    {
      "id": "mrr",
      "name": "MRR",
      "kind": "stock",
      "unit": "money",
      "dimensions": [
        "plan"
      ],
      "grains": [
        "day"
      ]
    }
  ]
}
```

</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.