GET
/
users
curl --request GET \
  --url https://ebn.telemetree.io/public-api/users \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "counts": [],
    "dates": [
      "2024-08-01",
      "2024-08-02",
      "2024-08-03"
    ],
    "filters": [
      {
        "op": "is",
        "prop": "country",
        "values": [
          "United States"
        ]
      }
    ],
    "groupBy": [
      "is_premium"
    ],
    "groups": {
      "0": [
        1,
        3,
        6
      ],
      "1": [
        1,
        0,
        0
      ]
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your API Key (Dashboard->Settings)

Query Parameters

​
group_by
enum<string>[] | null

List of fields to group by

Available options:
is_premium,
language,
referrer_type,
os,
brand,
model,
country,
write_access
​
start
string
required

Start date in YYYYMMDD format

​
end
string
required

End date in YYYYMMDD format

​
segments
string[] | null

Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]

Response

200
application/json
Successful Response
​
data
object
required

User count data

Example:
{
  "counts": [],
  "dates": ["2024-08-01", "2024-08-02", "2024-08-03"],
  "filters": [
    {
      "op": "is",
      "prop": "country",
      "values": ["United States"]
    }
  ],
  "groupBy": ["is_premium"],
  "groups": { "0": [1, 3, 6], "1": [1, 0, 0] }
}