List pipeline detections

GET

workspaces

{workspaceId}

pipelines

{pipelineId}

detections

List pipeline detections

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections', 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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"

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

	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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")

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

request = Net::HTTP::Get.new(url)

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

{
  "items": [
    {
      "id": "<string>",
      "inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {
        "error": "<string>",
        "tags": [
          "<string>"
        ],
        "usage": "<unknown>"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "status": "pending",
      "triggerType": "user",
      "triggeredBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "username": "<string>",
        "avatarUrl": "<string>",
        "displayName": "<string>"
      },
      "workspaceHandle": "<string>",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "completedAt": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "inputDocumentName": "<string>",
      "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "nextCursor": "<string>",
  "total": 123
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

Path Parameters

workspaceId

string<uuid>

required

Workspace identifier.

pipelineId

string<uuid>

required

Id of the pipeline.

Query Parameters

after

string

Cursor pointing to the last item of the previous page. Obtain this from the nextCursor field in the response.

includeCount

boolean

default:false

Whether to include the total item count in the response's total field. Defaults to false, since counting is an extra query; set it to true only when the count is actually needed.

limit

integer<uint32>

The maximum number of records to return (1-100, default: 20).

Required range: 1 <= x <= 100

documentId

string<uuid>

Filter by the source document the detection analyzes.

status

Filter by detection status.

Allowed value: "pending"

triggerType

Filter by how the detection was initiated (user vs system).

Allowed value: "user"

triggeredBy

string<uuid>

Filter by the account that triggered the detection.

Response

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

items

object[]

required

Items in this page.

Show child attributes

nextCursor

string

Cursor to fetch the next page. Present only when more items exist.

total

integer<int64>

Total count of items matching the query (if requested).

List pipeline detections

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections', 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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"

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

	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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")

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

request = Net::HTTP::Get.new(url)

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

{
  "items": [
    {
      "id": "<string>",
      "inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {
        "error": "<string>",
        "tags": [
          "<string>"
        ],
        "usage": "<unknown>"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "status": "pending",
      "triggerType": "user",
      "triggeredBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "username": "<string>",
        "avatarUrl": "<string>",
        "displayName": "<string>"
      },
      "workspaceHandle": "<string>",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "completedAt": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "inputDocumentName": "<string>",
      "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "nextCursor": "<string>",
  "total": 123
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

API Reference

Endpoints

List pipeline detections

Path Parameters

Query Parameters

Response