Skip to content
Nexa Platform Docs

Connectors overview

GET
/api/v1/observability/connectors
curl --request GET \
  --url 'https://example.com/api/v1/observability/connectors?days=1&include_summary=true&include_jobs=true&status=all&sort_by=modified_time&sort_order=desc&limit=25&offset=0&include_settings=false'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
days
Days

Lookback window (days) for run-based metrics

integer
default: 1 >= 1 <= 365

Lookback window (days) for run-based metrics

include_summary
Include Summary

Include connector status summary

boolean
default: true

Include connector status summary

include_jobs
Include Jobs

Include connector-tagged jobs list

boolean
default: true

Include connector-tagged jobs list

status
Status

Filter by job status: all, failed, running, succeeded, canceled

string
default: all

Filter by job status: all, failed, running, succeeded, canceled

search
Any of:
string

Search in job names (case-insensitive substring match) or by exact job ID

sort_by
Sort By

Sort by: job_name, modified_time, created_time

string
default: modified_time

Sort by: job_name, modified_time, created_time

sort_order
Sort Order

Sort order: asc, desc

string
default: desc

Sort order: asc, desc

limit
Limit

Number of jobs to return per page

integer
default: 25 >= 1 <= 100

Number of jobs to return per page

offset
Offset

Pagination offset

integer
0

Pagination offset

include_settings
Include Settings

Include full job settings/tasks in response

boolean

Include full job settings/tasks in response

Responses

Section titled “Responses”

200

Section titled “200”

Counts, windowed performance, highlights, and attention list

Media typeapplication/json
Response Get Connectors Overview Api V1 Observability Connectors Get
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}