Data In & Out APIs

List of APIs to write and read data

Data In (Write) API

The API to ingest data on to the Obsrv.

This API allows user to ingest data of either batch type or individual events based on dataset configuration. For batch type data, API expects events as key and for individual data type it expects event as key under request payload.

POST<Your-Host-IP>:3000/data/v1/in/{datasetId}

Path parameters

datasetId*string

Body

application/json

dataobject

Response

200400404

OK

Body

application/json

idstring

verstring

tsinteger

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/data/v1/in/{datasetId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "id": "uuid01",
        "events": []
      }
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.dataset.data.in",
  "ver": "v1",
  "ts": 1679916559382,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": {
    "message": "The data has been successfully ingested"
  }
}

Data Out (Read) APIs

API used to fetch data using native JSON query.

This API provides secure and convenient way to execute native JSON queries against Obsrv database along with filter options such as filters on the date ranges, required fields etc.

POST<Your-Host-IP>:3000/data/v1/query

Body

application/json

contextobject

queryobject

Response

200400

OK

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/data/v1/query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "context": {
        "dataSource": "telemetry-events"
      },
      "query": {
        "queryType": "scan",
        "dataSource": "telemetry-events",
        "granularity": "all",
        "intervals": [
          "2021-01-04/2021-01-19"
        ],
        "limit": 100,
        "columns": [
          "actor_type",
          "mid",
          "eid"
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.native.query",
  "ver": "v1",
  "ts": 1672679516875,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": [
    {
      "actor_type": "User",
      "mid": "d4b95f40-e5d7-475e-9a56-61e320b794ac",
      "eid": "INTERRUPT"
    },
    {
      "actor_type": "User",
      "mid": "f6e0ca10-d041-418f-b361-39177aafef77",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "47377f2b-82ab-43ec-abb1-091b53574dee",
      "eid": "INTERRUPT"
    },
    {
      "actor_type": "User",
      "mid": "7b790e8f-a5b2-43f2-b997-8054cf1508a7",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "437200ef-6d83-4995-bb74-9fd1ed8e7548",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "51f2e58e-c758-4b99-a5ab-956d3083f82e",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "b20df4dc-e7e9-4332-8a59-3a9722b7a427",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "00ae72fd-5ada-4d3f-bdce-eb30faa86567",
      "eid": "INTERRUPT"
    },
    {
      "actor_type": "User",
      "mid": "45800629-6198-40d8-8592-406f4a6bd207",
      "eid": "INTERRUPT"
    },
    {
      "actor_type": "User",
      "mid": "7890867f-9e5a-4909-be0e-9050096ed6a0",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "10a76da8-e18a-4116-8a58-0a6f21283b46",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "6550efe2-ead4-4257-9788-7cfe5c7920d6",
      "eid": "END"
    },
    {
      "actor_type": "User",
      "mid": "32933baa-15f9-423e-ac16-a5afda7447cb",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "9c41f03a-8a57-49ff-8fd4-fe604edfb69f",
      "eid": "IMPRESSION"
    },
    {
      "actor_type": "User",
      "mid": "1832fd59-2e38-4309-8983-424afa19dd75",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "928f83d3-c9fb-4416-8573-c8eb4f18993b",
      "eid": "INTERACT"
    },
    {
      "actor_type": "User",
      "mid": "c666a231-bb8f-4121-85ab-e48c066a26bf",
      "eid": "IMPRESSION"
    },
    {
      "actor_type": "User",
      "mid": "7d92eaef-474c-49ef-b886-c2bc516869b5",
      "eid": "IMPRESSION"
    },
    {
      "actor_type": "User",
      "mid": "7cb63a34-dfb6-45aa-9d57-bc8dc658b61d",
      "eid": "IMPRESSION"
    },
    {
      "actor_type": "User",
      "mid": "57b56970-fe96-4e2f-b5ea-6869a291d4af",
      "eid": "START"
    },
    {
      "actor_type": "User",
      "mid": "e12e8da7-9d4a-4161-bb81-9043edef21d1",
      "eid": "INTERACT"
    }
  ]
}

API used to fetch data using a sql query.

This API provides secure and convenient way to execute SQL queries against Obsrv database

POST<Your-Host-IP>:3000/data/v1/sql-query

Body

application/json

contextobject

querySqlobject

Response

200400

OK

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/data/v1/sql-query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "context": {
        "dataSource": "telemetry-events"
      },
      "querySql": {
        "query": "SELECT object_id AS contentId, COUNT(*) AS totalRatingsCount FROM \"telemetry-events\"  WHERE __time >= TIMESTAMP '2021-01-01' AND __time < TIMESTAMP '2021-01-02' GROUP BY object_id LIMIT 100"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "obsrv.sql.query",
  "ver": "v1",
  "ts": 1672679516875,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": [
    {
      "contentId": "",
      "totalRatingsCount": 288399
    },
    {
      "contentId": "002db515-fd79-41ae-a9c7-77dc49ff89ea",
      "totalRatingsCount": 6
    },
    {
      "contentId": "005833a6-94cc-4ad3-99ca-6e36fdbc703e",
      "totalRatingsCount": 1
    },
    {
      "contentId": "0083d213-f5a5-473d-8210-7d8ee3d053f1",
      "totalRatingsCount": 2
    },
    {
      "contentId": "00b2da5b-fcd3-4fd3-a599-1e6844a60ef1",
      "totalRatingsCount": 2
    },
    {
      "contentId": "00baa1ad-bc09-457b-a2ae-20b641f848fe",
      "totalRatingsCount": 4
    },
    {
      "contentId": "00be98d9-551a-484a-9921-02e12a98cd64",
      "totalRatingsCount": 1
    },
    {
      "contentId": "00c3d37d-5f6c-488a-9e46-f89f0f8f03a9",
      "totalRatingsCount": 1
    },
    {
      "contentId": "00c6eb03-f1cb-40d5-8464-d241995bee62",
      "totalRatingsCount": 2
    },
    {
      "contentId": "00f808de-e636-4718-908a-a852f256fb4e",
      "totalRatingsCount": 6
    },
    {
      "contentId": "0123a745-8269-46e4-bd04-812d29a4dea9",
      "totalRatingsCount": 1
    },
    {
      "contentId": "0131360986084147202",
      "totalRatingsCount": 25
    },
    {
      "contentId": "01315371693530316815",
      "totalRatingsCount": 28
    },
    {
      "contentId": "0131595563210915841",
      "totalRatingsCount": 10
    },
    {
      "contentId": "0131595654717767682",
      "totalRatingsCount": 3
    },
    {
      "contentId": "0131687259471380480",
      "totalRatingsCount": 6
    },
    {
      "contentId": "0131687266805923840",
      "totalRatingsCount": 9
    },
    {
      "contentId": "0131728888777031684",
      "totalRatingsCount": 173
    },
    {
      "contentId": "0131728891335802883",
      "totalRatingsCount": 51
    },
    {
      "contentId": "0131728907872583684",
      "totalRatingsCount": 65
    }
  ]
}

API to access data files from different stages of processing.

GET<Your-Host-IP>:3000/data/v1/exhaust/{datasetId}

Path parameters

datasetId*string

Query parameters

Response

200400

OK

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('<Your-Host-IP>:3000/data/v1/exhaust/{datasetId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "obsrv.dataset.data.exhaust",
  "ver": "v1",
  "ts": 1693891173180,
  "params": {
    "status": "SUCCESS",
    "errmsg": "text"
  },
  "responseCode": "OK",
  "result": {
    "expiresAt": "2023-09-05T06:19:33.176Z",
    "files": [
      "file1",
      "file2"
    ],
    "periodWiseFiles": {
      "2023-06-15": [
        "file1",
        "file2"
      ]
    }
  }
}