Sync Integration History

GET

integrations

sync

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "nextCursor": "<string>",
  "moreData": true,
  "history": [
    {
      "externalId": "<string>",
      "taskName": "<string>",
      "errorCount": 123,
      "warningCount": 123,
      "fatalCount": 123,
      "startTime": 1730204346000,
      "message": "<string>",
      "activeConfigRevision": 123,
      "endTime": 1730204346000,
      "sources": [
        "<string>"
      ],
      "targets": [
        "<string>"
      ]
    }
  ],
  "errors": [
    {
      "type": "general",
      "externalId": "my.integrations.id",
      "level": "warning",
      "description": "<string>",
      "details": "<string>",
      "startTime": 1730204346000,
      "task": "<string>",
      "activeConfigRevision": 123,
      "endTime": 1730204346000
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "`null` values aren't allowed."
  }
}

{
  "error": {
    "code": 422,
    "message": "Extra inputs are not permitted: type"
  }
}

Authorizations

Authorization

string

header

required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Query Parameters

externalId

string

required

Return task histories and errors belonging to a specific integration.

taskName

string

Return task histories and errors belonging to a specific task.

includeErrors

boolean

If true, include errors in the response. One of this and includeTaskUpdates must be true.

includeTaskUpdates

boolean

If true, include task history in the response. One of this and includeErrors must be true.

startTime

integer

The earliest date by which to filter the task history.

limit

integer

default:100

Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.

Required range: 1 <= x <= 100

cursor

string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

Response

List of task histories and errors, with a cursor.

Response for the sync endpoint.

nextCursor

string

required

Cursor for pagination

moreData

boolean

required

If true, there is more data available, and you should call this endpoint again with the returned cursor.

history

TaskHistoryWithErrors · object[]

List of task histories.

Show child attributes

errors

ErrorWithTaskRead · object[]

List of errors.

Show child attributes

⌘I

Sync Integration History

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/integrations/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "nextCursor": "<string>",
  "moreData": true,
  "history": [
    {
      "externalId": "<string>",
      "taskName": "<string>",
      "errorCount": 123,
      "warningCount": 123,
      "fatalCount": 123,
      "startTime": 1730204346000,
      "message": "<string>",
      "activeConfigRevision": 123,
      "endTime": 1730204346000,
      "sources": [
        "<string>"
      ],
      "targets": [
        "<string>"
      ]
    }
  ],
  "errors": [
    {
      "type": "general",
      "externalId": "my.integrations.id",
      "level": "warning",
      "description": "<string>",
      "details": "<string>",
      "startTime": 1730204346000,
      "task": "<string>",
      "activeConfigRevision": 123,
      "endTime": 1730204346000
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "`null` values aren't allowed."
  }
}

{
  "error": {
    "code": 422,
    "message": "Extra inputs are not permitted: type"
  }
}