Cint Fielding API
Create, update and obtain Target Group Fielding runs and Fielding Assistant assignments. This is critical for launching, scheduling and completing Target Groups.
OpenAPI Specification
openapi: 3.0.3
info:
title: Demand Accounts Fielding API
description: 'Cint''s demand ordering API is REST oriented. It has predictable resource based URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Error responses are also JSON-encoded and follow a standard format, providing a unique error ID and detailed information about what went wrong.
Authentication is handled via bearer tokens passed in the `Authorization` header. All requests must also include a `Cint-API-Version` header with a date in `YYYY-MM-DD` format to specify the desired API version. Depending on the version you use, endpoint behavior may differ as we improve our API with every version release.
While many operations work on a single object per request, the demand ordering API also provides asynchronous batch endpoints for performing bulk updates efficiently on certain resources. For safety, `POST` requests support an `Idempotency-Key` header to allow for safe retries without accidentally performing the same operation twice.
'
version: '2025-12-18'
servers:
- description: Production server
url: https://api.cint.com/v1
security:
- BearerAuth: []
tags:
- name: Fielding
description: Create, update and obtain Target Group Fielding runs and Fielding Assistant assignments. This is critical for launching, scheduling and completing Target Groups.
paths:
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-run-jobs/launch-from-draft:
parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
summary: Job to launch a draft target group
description: 'Creates an asynchronous job to launch a `draft` target group, setting its status to `live`.
A `201 Created` response indicates that the job was successfully created, not that the target group is live.
To check the outcome, you must poll the job status URL returned in the `Location` header.
You can find the details for the status endpoint here: [Get launch job status](./get-launch-fielding-run-from-draft-job).
'
operationId: create_launch_fielding_run_from_draft_job
parameters:
- $ref: '#/components/parameters/IdempotencyKeyRequired'
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
requestBody:
description: The desired end date for the fielding run.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLaunchFieldingRunFromDraftJobRequest'
example:
end_fielding_at: '2024-12-31T23:59:59.000Z'
tags:
- Fielding
responses:
'201':
description: The job was created successfully. Poll the URL in the `Location` header to track its status.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
location:
$ref: '#/components/headers/Location'
example: /demand/accounts/101/projects/01BTGNYV6HRNK8K8VKZASZCFP0/target-groups/01BTGNYV6HRNK8K8VKZASZCFP1/fielding-run-jobs/launch-from-draft/01BTGNYV6HRNK8K8VKZASZCFP1
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
? /demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-run-jobs/launch-from-draft/{job_id}
: parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
get:
summary: Retrieves a "launch from draft" job status
description: 'Retrieves the status and results of a "launch from draft" job.
You should poll this endpoint periodically until the `status` field is either `Completed` or `Failed`.
* If the status is `Completed`, the `created_fielding_run_id` field will contain the ID of the new fielding run.
* If the status is `Failed`, the `failure_reason` object will provide details about the error.
'
operationId: get_launch_fielding_run_from_draft_job
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/JobID'
tags:
- Fielding
responses:
'200':
description: The "launch from draft" job details were retrieved successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
content:
application/json:
schema:
$ref: '#/components/schemas/GetLaunchFieldingRunFromDraftJobResponse'
examples:
completed:
summary: Completed
description: A successfully completed launch job
value:
job_id: 01BTGNYV6HRNK8K8VKZASZCFP1
created_fielding_run_id: 01BTGNYV6HRNK8K8VKZASZCFP2
created_at: '2023-01-01T23:00:00.000Z'
created_by: b551326b-ac9d-4d32-8823-4f025787dab9
status: Completed
failure_reason: null
job_trace_id: null
failed:
summary: Failed
description: A failed launch job with error details
value:
job_id: 01BTGNYV6HRNK8K8VKZASZCFP1
created_fielding_run_id: null
created_at: '2023-01-01T23:00:00.000Z'
created_by: b551326b-ac9d-4d32-8823-4f025787dab9
status: Failed
failure_reason:
code: TargetGroupInvalidState
description: The target group is not in a draft state and cannot be launched.
job_trace_id: 0af7651916cd43dd8448eb211c80319c
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-run-jobs/schedule-from-draft:
parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
summary: Schedules a draft target group to go live
description: 'Creates an asynchronous job to schedule a `draft` target group, setting its status to `scheduled`.
A `201 Created` response indicates that the job was successfully created, not that the target group is scheduled.
To check the outcome, you must poll the job status URL returned in the `Location` header.
You can find the details for the status endpoint here: [Get schedule job status](./get-schedule-fielding-run-from-draft-job).
'
operationId: create_schedule_fielding_run_from_draft_job
parameters:
- $ref: '#/components/parameters/IdempotencyKeyRequired'
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
requestBody:
description: The desired start and end dates for the fielding run.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduleFieldingRunFromDraftJobRequest'
example:
start_fielding_at: '2024-09-01T09:00:00.000Z'
end_fielding_at": '2024-09-30T23:59:59.000Z'
tags:
- Fielding
responses:
'201':
description: The job was created successfully. Poll the URL in the `Location` header to track its status.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
location:
$ref: '#/components/headers/Location'
example: /demand/accounts/101/projects/01BTGNYV6HRNK8K8VKZASZCFP0/target-groups/01BTGNYV6HRNK8K8VKZASZCFP1/fielding-run-jobs/schedule-from-draft/01BTGNYV6HRNK8K8VKZASZCFP1
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
? /demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-run-jobs/schedule-from-draft/{job_id}
: parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
get:
summary: Retrieves a "schedule from draft" job status
description: 'Retrieves the status and results of a "schedule from draft" job.
You should poll this endpoint periodically until the `status` field is either `Completed` or `Failed`.
Once the job is finished, the `created_fielding_run_id` field will contain the ID of the created fielding run.
'
operationId: get_schedule_fielding_run_from_draft_job
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/JobID'
tags:
- Fielding
responses:
'200':
description: The "schedule from draft" job details were retrieved successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
content:
application/json:
schema:
$ref: '#/components/schemas/GetScheduleFieldingRunFromDraftJobResponse'
examples:
completed:
summary: Completed
description: A successfully completed schedule job
value:
job_id: 01BTGNYV6HRNK8K8VKZASZCFP1
created_fielding_run_id: 01BTGNYV6HRNK8K8VKZASZCFP2
created_at: '2023-01-01T23:00:00.000Z'
created_by: b551326b-ac9d-4d32-8823-4f025787dab9
status: Completed
failure_reason: null
job_trace_id: null
failed:
summary: Failed
description: A failed schedule job with error details
value:
job_id: 01BTGNYV6HRNK8K8VKZASZCFP1
created_fielding_run_id: null
created_at: '2023-01-01T23:00:00.000Z'
created_by: b551326b-ac9d-4d32-8823-4f025787dab9
status: Failed
failure_reason:
code: InvalidFieldingDates
description: The provided start time is in the past.
job_trace_id: 0af7651916cd43dd8448eb211c80319c
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs:
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
get:
summary: Lists the fielding runs for a target group
description: 'Lists the fielding runs associated with a target group.
A fielding run defines the time period during which a target group is live and collecting data.
**Note:** A target group can have at most one fielding run at any time.
Therefore, the `data` array in the response will contain either zero or one item, and the `has_more` flag will always be `false`.
'
operationId: get_fielding_runs_by_target_group_id
tags:
- Fielding
responses:
'200':
description: The fielding run details were retrieved successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
content:
application/json:
schema:
$ref: '#/components/schemas/GetListFieldingRunsResponse'
example:
data:
- id: 01BTGNYV6HRNK8K8VKZASZCFP1
last_changed_at: '2023-01-01T23:00:00.000Z'
last_changed_by: b551326b-ac9d-4d32-8823-4f025787dab9
start_fielding_at: '2023-01-02T09:00:00.000Z'
end_fielding_at: '2023-01-31T23:59:59.000Z'
status: live
version: 5
has_more: false
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}:
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
get:
summary: Retrieves a fielding run
description: Retrieves the details of a specific fielding run, including its start and end times, status, and version.
operationId: get_fielding_run
tags:
- Fielding
responses:
'200':
description: The fielding run details were retrieved successfully. Note the `ETag` header, which is required for making updates.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/GetFieldingRunResponse'
example:
id: 01BTGNYV6HRNK8K8VKZASZCFP1
last_changed_at: '2023-01-01T23:00:00.000Z'
last_changed_by: b551326b-ac9d-4d32-8823-4f025787dab9
start_fielding_at: '2023-01-02T09:00:00.000Z'
end_fielding_at: '2023-01-31T23:59:59.000Z'
status: scheduled
version: 5
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
put:
summary: Updates a fielding run
description: 'Updates the `start_fielding_at` and `end_fielding_at` dates for a specific fielding run.
This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for this resource.
Fielding runs can only be updated for target groups in either scheduled, live or paused status. The operation will fail if the target group status is `completed`.
'
operationId: update_fielding_run
parameters:
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: The fielding run update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFieldingRunRequest'
example:
start_fielding_at: '2024-10-01T09:00:00.000Z'
end_fielding_at: '2024-10-31T23:59:59.000Z'
responses:
'202':
description: The request to update the fielding run was accepted successfully. The `ETag` header in the response contains the new version of the resource.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFieldingRunResponse'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
? /demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}/complete
: parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
operationId: complete_fielding_run
summary: Completes a fielding run
description: 'Immediately completes a `live` or `scheduled` fielding run, setting its status to `completed`.
This action will close the target group to new respondents, regardless of whether its completes goal or end date has been reached.
This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for this resource.
'
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: An empty request body is required for this operation.
required: false
content: {}
responses:
'204':
description: The request to complete the fielding run was accepted successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
? /demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}/launch-now
: parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
operationId: launch_now_fielding_run
summary: Launches fielding run immediately
description: 'Immediately launches a `scheduled` fielding run, setting its status to `live`.
This action updates the `start_fielding_at` timestamp to the current time.
The `end_fielding_at` timestamp is also recalculated to preserve the original fielding duration.
This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for the resource.
'
parameters:
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: An empty request body is required for this operation.
required: false
content: {}
responses:
'200':
description: The fielding run was launched successfully. The response body contains the updated start and end times.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/LaunchNowFieldingRunResponse'
example:
start_fielding_at: '2024-08-01T10:00:00.000Z'
end_fielding_at: '2024-08-15T10:00:00.000Z'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}/pause:
parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
operationId: pause_fielding_run
summary: Pauses a fielding run
description: 'Pauses a `live` fielding run, setting its status to `paused`.
While a fielding run is paused, it will not collect new completes. You can set it `live` again using the `resume` endpoint.
This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for this resource.
'
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: An empty request body is required for this operation.
required: false
content: {}
responses:
'204':
description: The fielding run was paused successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
? /demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}/relaunch
: parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
operationId: relaunch_fielding_run
summary: Relaunches a fielding run
description: 'Relaunches a `completed` fielding run, setting its status back to `live`.
Key behaviors:
* A fielding run will only be relaunched if its completes goal and end date have not yet been reached.
* This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for this resource.
'
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: An empty request body is required for this operation.
required: false
content: {}
responses:
'204':
description: The fielding run was relaunched successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
/demand/accounts/{account_id}/projects/{project_id}/target-groups/{target_group_id}/fielding-runs/{fielding_run_id}/resume:
parameters:
- $ref: '#/components/parameters/CintAPIVersion-2025-12-18'
post:
operationId: resume_fielding_run
summary: Resumes a fielding run
description: 'Resumes a `paused` fielding run, setting its status back to `live`.
Key behaviors:
* A fielding run will only be resumed if its completes goal and end date have not yet been reached.
* This endpoint uses optimistic locking. You must provide the fielding run''s current version in the `If-Match` header.
You can get this value from the `ETag` header of a `GET` request for this resource.
'
parameters:
- $ref: '#/components/parameters/AccountID'
- $ref: '#/components/parameters/ProjectID'
- $ref: '#/components/parameters/TargetGroupID'
- $ref: '#/components/parameters/FieldingRunID'
- $ref: '#/components/parameters/IfMatchRequired'
tags:
- Fielding
requestBody:
description: An empty request body is required for this operation.
required: false
content: {}
responses:
'204':
description: The fielding run was resumed successfully.
headers:
traceparent:
$ref: '#/components/headers/Traceparent'
tracestate:
$ref: '#/components/headers/Tracestate'
etag:
$ref: '#/components/headers/ETag'
'400':
$ref: '#/components/responses/Error_BadRequest'
'401':
$ref: '#/components/responses/Error_Unauthorized'
'403':
$ref: '#/components/responses/Error_Forbidden'
'404':
$ref: '#/components/responses/Error_NotFound'
'412':
$ref: '#/components/responses/Precondition_Failed'
'422':
$ref: '#/components/responses/Error_InvalidState'
'429':
$ref: '#/components/responses/Error_RateLimit'
'500':
$ref: '#/components/responses/Error_Internal'
components:
schemas:
JobID:
description: The character string representing a unique job ID.
type: string
example: 01BTGNYV6HRNK8K8VKZASZCFP1
CreateLaunchFieldingRunFromDraftJobRequest:
type: object
description: Request body for creating a `launch fielding run from draft` job.
properties:
end_fielding_at:
type: string
format: date-time
description: 'The timestamp the fielding run is scheduled to end at (RFC3339 UTC format, 3 fractional digits). '
example: '2023-01-01T23:00:00.000Z'
required:
- end_fielding_at
GetListFieldingRunsResponse:
type: object
description: List of fielding runs for a given target group id.
properties:
data:
type: array
description: 'An array containing the fielding run for the target group.
**Note:** A target group can have at most one fielding run, so this array will contain zero or one item.
'
items:
$ref: '#/components/schemas/FieldingRunItem'
has_more:
type: boolean
description: This field is always `false` as a target group can have at most one fielding run.
enum:
- false
required:
- data
- has_more
ETag:
type: string
description: The `ETag` header provides a unique identifier that represents the current version state of a particular resource.
example: W/"1234"
CreateScheduleFieldingRunFromDraftJobRequest:
type: object
description: Request body for creating a `schedule fielding run from draft` job.
properties:
start_fielding_at:
type: string
format: date-time
description: The timestamp the fielding run is scheduled to start at(RFC3339 UTC format, 3 fractional digits). The start time cannot be in the past.
example: '2023-01-01T23:00:00.000Z'
end_fielding_at:
type: string
format: date-time
description: 'The timestamp the fielding run is scheduled to end at (RFC3339 UTC format, 3 fractional digits). The end time has to be after the starting time. '
example: '2023-01-31T23:59:59.000Z'
required:
- start_fielding_at
- end_fielding_at
UpdateFieldingRunResponse:
type: object
description: Response for updating a fielding run for a given target group id.
properties:
id:
$ref: '#/components/schemas/FieldingRunID'
required:
- id
GetFieldingRunResponse:
allOf:
- $ref: '#/components/schemas/FieldingRunItem'
- description: Fielding run details.
FieldingRunStatus:
description: The current status of a fielding run. A `scheduled` run will beco
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cint/refs/heads/main/openapi/cint-fielding-api-openapi.yml