Entities

Get Entities List

Gets Entity list within an account. This API can be used to get all Entities or filter by name.

Query Parameters

?name=

Name of the entity. By default, it performs a contains match. To match the exact entity name, set the value with double quotes.

?offset=

Index to start for the next paginated request. Default value is 0.

?limit=

Number of items to include in each page result. There could be fewer items remaining than the specified value.

Example request

::::: tabs ::: code-tab bash

\$ curl -H \"Authorization: Bearer \<token>\" [https://app3.falkonry.ai/api/1.2/accounts/xxxxxxxxxxxxxxx/entities?offset=0&limit=10&name=\\"Machine_1\](https://app3.falkonry.ai/api/1.2/accounts/xxxxxxxxxxxxxxx/entities?offset=0&limit=10&name=\%22Machine_1)\" :::

::: code-tab python

import requests URL = \'https://app3.falkonry.ai/api/1.2/accounts/xxxxxxxxxxxxxxx/entities?offset=0&limit=10&name=\"Machine_1\" TOKEN = \'\<token>\' HEADERS = {\'Authorization\': f\'Bearer {TOKEN}\'} response = requests.get(URL, headers=HEADERS) print(response.json()) ::: :::::

Example response

[
  {
    "id": "eeeeeeeeeeeeeeeeee",
    "name": "Machine_1",
    "key": "machine_1",
    "type": "entities.entity",
    "datastream": "yyyyyyyyyyyy",
    "tenant": "xxxxxxxxxxxxxxx",
    "createTime": 1661671135931,
    "updateTime": 1661782660488,
    "createdBy": "pod",
    "updatedBy": "pod",
    "archived": false,
    "stats": {
      "events": 561120,
      "earliestDataPoint": "2022-08-26T19:25:30.000000Z",
      "latestDataPoint": "2022-08-29T13:47:10.000000Z",
      "dataSize": 0
    },
    "tags": [],
    "links": []
  }
]

Note

To paginate through results, begin with an offset value of 0 and a limit value of N. To get the next page, set offset value to N, while the limit value stays the same. Subsequent pages start at 2N, 3N, 4N, and so on.

Get an Entity

Get an Entity by ID within an account.

Example request

::::: tabs ::: code-tab bash

\$ curl -H \"Authorization: Bearer \<token>\" https://app3.falkonry.ai/api/1.2/accounts/xxxxxxxxxxxxxxx/entities/eeeeeeeeeeeeee :::

::: code-tab python

import requests URL = \'https://app3.falkonry.ai/api/1.2/accounts/xxxxxxxxxxxxxxx/entities/eeeeeeeeeeeeee TOKEN = \'\<token>\' HEADERS = {\'Authorization\': f\'Bearer {TOKEN}\'} response = requests.get(URL, headers=HEADERS) print(response.json()) ::: :::::

Example response

{
  "id": "eeeeeeeeeeeeeeeeee",
  "name": "Machine_1",
  "key": "machine_1",
  "type": "entities.entity",
  "datastream": "yyyyyyyyyyyy",
  "tenant": "xxxxxxxxxxxxxxx",
  "createTime": 1661671135931,
  "updateTime": 1661782660488,
  "createdBy": "pod",
  "updatedBy": "pod",
  "archived": false,
  "stats": {
    "events": 561120,
    "earliestDataPoint": "2022-08-26T19:25:30.000000Z",
    "latestDataPoint": "2022-08-29T13:47:10.000000Z",
    "dataSize": 0
  },
  "tags": [],
  "links": []
}