Query pipeline executions

curl --request POST \
  --url https://api.{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/pipelines/query \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "query": {
    "and": "<array>",
    "id": "<string>"
  },
  "filter": {
    "and": "<array>",
    "id": "<string>"
  },
  "properties": {
    "include": [
      "<string>"
    ],
    "exclude": [
      "<string>"
    ]
  },
  "highlighting": [
    "<string>"
  ],
  "page": 123,
  "perPage": 20,
  "aggregations": [
    {
      "path": "<string>",
      "prefix": "<string>",
      "size": 20
    }
  ],
  "traversedProperties": [
    "<string>"
  ]
}
'

{
  "hits": [
    {
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "numPages": 123,
    "page": 123,
    "perPage": 123,
    "total": 123,
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  },
  "aggregates": [
    {
      "path": "<string>",
      "aggregate": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "semanticQueryInfo": {
    "originalQuery": "<string>",
    "reasoning": "<string>",
    "query": {
      "and": "<array>",
      "id": "<string>"
    },
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  }
}

Pipeline Executions

Query pipeline executions

Query the pipeline executions of a source. The fields that can be used to filter or sort pipeline executions are:

id: The pipeline execution id.
pipelineDefinitionId: The pipeline definition id.
createdAt: The pipeline execution creation timestamp.
updatedAt: The pipeline execution last update timestamp.
status: The pipeline execution status.
operation.action: The action of the operation that triggered the pipeline execution.
operation.taskId: The id of the task that triggered the pipeline execution.
operation.target.targetType: The type of the target that triggered the pipeline execution. It can be ‘RESOURCE’ or ‘RELATIONSHIP’.
operation.target.type: The type of the resource or relationship that triggered the pipeline execution.
operation.target.id: The id of the resource or relationship that triggered the pipeline execution.
reviewAssignment.reviewerId: The id of the reviewer assigned to review the operation that triggered the pipeline execution, if any. Note: this field is only available as a filter, not as a sort field. It also only supports the equality operator.

POST

sources

{sourceKey}

pipelines

query

Query pipeline executions

curl --request POST \
  --url https://api.{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/pipelines/query \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "query": {
    "and": "<array>",
    "id": "<string>"
  },
  "filter": {
    "and": "<array>",
    "id": "<string>"
  },
  "properties": {
    "include": [
      "<string>"
    ],
    "exclude": [
      "<string>"
    ]
  },
  "highlighting": [
    "<string>"
  ],
  "page": 123,
  "perPage": 20,
  "aggregations": [
    {
      "path": "<string>",
      "prefix": "<string>",
      "size": 20
    }
  ],
  "traversedProperties": [
    "<string>"
  ]
}
'

{
  "hits": [
    {
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "numPages": 123,
    "page": 123,
    "perPage": 123,
    "total": 123,
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  },
  "aggregates": [
    {
      "path": "<string>",
      "aggregate": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "semanticQueryInfo": {
    "originalQuery": "<string>",
    "reasoning": "<string>",
    "query": {
      "and": "<array>",
      "id": "<string>"
    },
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  }
}

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

sourceKey

string

required

The key of the source.

Query Parameters

withOperationBody

boolean

default:false

If set to true, the response will include, for each pipeline execution, the body of the operation which triggered the pipeline. Defaults to false.

Body

application/json

Use dot-notation paths (e.g., name, meta.updatedAt, address.city). To include properties from relationships or adjacent records, request them via traversedProperties and reference with @ (e.g., @worksAt.*, @worksAt.@clinic.name). Some endpoints require federated paths such as resources.<collectionKey>.<propertyKey> or relationships.<collectionKey>.<propertyKey>.

semanticQuery

object

A semantic query is a high-level representation of the user's intent. When specified, it will trigger our query understanding capabilities and generate a query and filter operator that will be applied to the search parameters.

Show child attributes

query

object

An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.

Show child attributes

filter

object

An operator that will be used to filter the targeted collections. The filtering operator excludes results that do not match the specified criteria.

Show child attributes

properties

object

Properties selector allows to specify which properties should be included or excluded in the search response. System properties are always included and cannot be excluded. Exclude properties has precedence over include properties.

Show child attributes

highlighting

string[]

page

integer<int32>

perPage

integer<int32>

default:20

sort

object

Show child attributes

aggregations

object[]

Show child attributes

traversedProperties

string[]

The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix

* will return all traversed properties.
@worksAt.* will return all traversed properties from the relationship 'worksAt'.
@worksAt.@clinic.* will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.

Response

A successful response.

hits

object[]

required

Show child attributes

Documentation Index

Authorizations

Path Parameters

Query Parameters

Body

Response