Chilkat Online Tools

phpAx / Cognite API v1 / Retrieve data points

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "items": [
//     {
//       "externalId": "ut culpa Excepteur",
//       "start": 0,
//       "end": -12222847,
//       "limit": 43358925,
//       "aggregates": [
//         "interpolation",
//         "max"
//       ],
//       "granularity": "a",
//       "includeOutsidePoints": false
//     },
//     {
//       "externalId": "aliquip",
//       "start": 0,
//       "end": -6309638,
//       "limit": 57543521,
//       "aggregates": [
//         "max",
//         "min"
//       ],
//       "granularity": "",
//       "includeOutsidePoints": false
//     }
//   ],
//   "start": "velit",
//   "end": 50328109,
//   "limit": 100,
//   "aggregates": [
//     "count",
//     "max"
//   ],
//   "granularity": "mollit dolore",
//   "includeOutsidePoints": false,
//   "ignoreUnknownIds": false
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('items[0].externalId','ut culpa Excepteur');
$json->UpdateInt('items[0].start',0);
$json->UpdateInt('items[0].end',-12222847);
$json->UpdateInt('items[0].limit',43358925);
$json->UpdateString('items[0].aggregates[0]','interpolation');
$json->UpdateString('items[0].aggregates[1]','max');
$json->UpdateString('items[0].granularity','a');
$json->UpdateBool('items[0].includeOutsidePoints',0);
$json->UpdateString('items[1].externalId','aliquip');
$json->UpdateInt('items[1].start',0);
$json->UpdateInt('items[1].end',-6309638);
$json->UpdateInt('items[1].limit',57543521);
$json->UpdateString('items[1].aggregates[0]','max');
$json->UpdateString('items[1].aggregates[1]','min');
$json->UpdateString('items[1].granularity','');
$json->UpdateBool('items[1].includeOutsidePoints',0);
$json->UpdateString('start','velit');
$json->UpdateInt('end',50328109);
$json->UpdateInt('limit',100);
$json->UpdateString('aggregates[0]','count');
$json->UpdateString('aggregates[1]','max');
$json->UpdateString('granularity','mollit dolore');
$json->UpdateBool('includeOutsidePoints',0);
$json->UpdateBool('ignoreUnknownIds',0);

$http->SetRequestHeader('content-type','application/json');
$http->SetRequestHeader('api-key','{{api-key}}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/timeseries/data/list','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "ut culpa Excepteur",
            "start": 0,
            "end": -12222847,
            "limit": 43358925,
            "aggregates": [
                "interpolation",
                "max"
            ],
            "granularity": "a",
            "includeOutsidePoints": false
        },
        {
            "externalId": "aliquip",
            "start": 0,
            "end": -6309638,
            "limit": 57543521,
            "aggregates": [
                "max",
                "min"
            ],
            "granularity": "",
            "includeOutsidePoints": false
        }
    ],
    "start": "velit",
    "end": 50328109,
    "limit": 100,
    "aggregates": [
        "count",
        "max"
    ],
    "granularity": "mollit dolore",
    "includeOutsidePoints": false,
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/data/list

Postman Collection Item JSON

{
  "id": "getMultiTimeSeriesDatapoints",
  "name": "Retrieve data points",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "data",
        "list"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Retrieves a list of data points from multiple time series in a project. This operation supports aggregation, but not pagination. A detailed description of how aggregates work can be found at [our concept guide for aggregation](<https://docs.cognite.com/dev/concepts/aggregation/>).",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"ut culpa Excepteur\",\n            \"start\": 0,\n            \"end\": -12222847,\n            \"limit\": 43358925,\n            \"aggregates\": [\n                \"interpolation\",\n                \"max\"\n            ],\n            \"granularity\": \"a\",\n            \"includeOutsidePoints\": false\n        },\n        {\n            \"externalId\": \"aliquip\",\n            \"start\": 0,\n            \"end\": -6309638,\n            \"limit\": 57543521,\n            \"aggregates\": [\n                \"max\",\n                \"min\"\n            ],\n            \"granularity\": \"\",\n            \"includeOutsidePoints\": false\n        }\n    ],\n    \"start\": \"velit\",\n    \"end\": 50328109,\n    \"limit\": 100,\n    \"aggregates\": [\n        \"count\",\n        \"max\"\n    ],\n    \"granularity\": \"mollit dolore\",\n    \"includeOutsidePoints\": false,\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}