Skip to content

Deel: Retrieve current application counts per interview plan stage

Deel ats.retrieveAtsInsightsStageCounts: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_retrieveatsinsightsstagecounts_v2026_10_28

Provider route: GET /ats/insights/stage-counts. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["ats"]["retrieveAtsInsightsStageCounts"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.ats.retrieveAtsInsightsStageCounts(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.ats.retrieve_ats_insights_stage_counts(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryModelOptionalExpand Retrieve average time per interview plan stage — request body — query
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Referenced models: Retrieve average time per interview plan stage — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve current application counts per interview plan stage — 200 response body

Referenced models: Retrieve current application counts per interview plan stage — 200 response body

Retrieve current application counts per interview plan stage — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentCurrent application counts per interview plan stage, ordered by stage position.
data[]ModelEach itemExpand Retrieve current application counts per interview plan stage — 200 response body — data item
has_morebooleanRequired within parentAlways false: the result is a single aggregate page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: the result is a single aggregate page.
next_cursor (anyOf 2)nullAlternativeAlways null: the result is a single aggregate page.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of rows in data.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve current application counts per interview plan stage — 200 response body — data item

Retrieve average time per interview plan stage — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
job_idsarrayOptional
job_ids[]stringEach itemFormat: uuid
hiring_member_hou_idsarrayOptional
hiring_member_hou_ids[]stringEach itemFormat: uuid
interview_plan_idsarrayOptional
interview_plan_ids[]stringEach itemFormat: uuid
department_idsarrayOptional
department_ids[]stringEach itemFormat: uuid
team_idsarrayOptional
team_ids[]stringEach itemFormat: uuid
employment_type_idsarrayOptional
employment_type_ids[]stringEach itemFormat: uuid
location_idsarrayOptional
location_ids[]stringEach itemFormat: uuid
candidate_tag_idsarrayOptional
candidate_tag_ids[]stringEach itemFormat: uuid
candidate_tag_ids_operatorstringOptionalOne of: ANY, ALL
source_slugsarrayOptional
source_slugs[]stringEach itemMaximum length: 50
job_statusesarrayOptional
job_statuses[]stringEach itemOne of: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, PAUSED, CLOSED, ARCHIVED
work_arrangementsarrayOptional
work_arrangements[]stringEach itemOne of: ON_SITE, HYBRID, REMOTE
date_range_startstringOptionalFormat: date-time
date_range_endstringOptionalFormat: date-time
workspace_idsarrayOptional
workspace_ids[]stringEach itemFormat: uuid
Retrieve current application counts per interview plan stage — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
applications_countJSONRequired within parent
applications_count (anyOf 1)integerAlternativeApplications currently in this stage
applications_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_type_slugstringRequired within parentCategory of the stage
Known values: LEAD, ACTIVE, COMPLETED
default_type_slugJSONOptional
default_type_slug (anyOf 1)stringAlternativeBuilt-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages
default_type_slug (anyOf 2)nullAlternativeBuilt-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages
interview_plan_stage_namestringRequired within parentCustomer-defined stage name
job_idJSONRequired within parent
job_id (anyOf 1)stringAlternativeJob the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null.
Format: uuid
job_id (anyOf 2)nullAlternativeJob the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null.
Format: uuid
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in its interview plan
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: deel.ats_retrieveatsinsightsstagecounts_v2026_10_28. Catalog operation: ats_retrieveatsinsightsstagecounts_v2026_10_28. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["ats:read", "worker:read"]

Pinned headers: {"X-Version": "2026-10-28"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.