Services

Get service counts and one merged, name-sorted page of services

Returns per-entity-type counts, a per-connector-type breakdown, an optional per-health-state breakdown, and one page of services sorted by name across every requested service type. Connection configuration is never returned.

Filter semantics: q narrows the count maps as well as the list. The three selectors (listEntityType, serviceType, health) narrow only data and paging.total, so a client can use each count map as the option list for its own filter control without that control eating its own menu.

offset + limit must not exceed 10000; use the per-service-type list APIs with cursor paging for deeper traversal.

get/v1/services/overview

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/services/overview
  • Auth: HTTP bearer

Query parameters

entityTypestring[]

Service entity types forming the universe for the count maps. Repeatable. Defaults to all.

listEntityTypestring[]

Restrict data to these service entity types. Repeatable. Defaults to the universe.

serviceTypestring[]

Connector type, e.g. Snowflake. Repeatable. Affects data only.

healthstring[]

Health state. Repeatable. Affects data only. Implies includeHealth.

qstring

Case-insensitive substring match on name and displayName.

includeHealthboolean

Compute per-service health. Costs three extra batched queries.

limitinteger
offsetinteger
sortOrderstring

Sort direction on name.

include'all' | 'deleted' | 'non-deleted'
domainstring

Fully qualified name of a domain to restrict results to.

excludeProvider'system' | 'user' | 'automation'

Exclude services with this provider, e.g. system.

Response

Service counts and one page of services

countsobject required
serviceTypeCountsobject required
healthCountsobject
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.