> ## Documentation Index > Fetch the complete documentation index at: https://docs.talqui.chat/llms.txt > Use this file to discover all available pages before exploring further. # Get campaign progress > Read-only aggregate progress for a single campaign — same shape as the `campaign:dispatch:progress` socket event talqui-core-api's dispatch engine emits (campaigns backend epic, task 15), so a client can poll this as a drift-correction fallback whenever it may have missed a socket event (reconnect, tab refocus, periodic refresh, manual "atualizar" button) without needing to reconcile a different shape. Works standalone too — a client that never connects to the socket can track a campaign end-to-end using only this endpoint. ## OpenAPI ````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/campaigns/{campaignID}/progress openapi: 3.0.3 info: description: >- Talqui is an omnichannel customer service platform that unifies conversations from WhatsApp, Instagram, Telegram, and many other channels into a single attendant panel, alongside a broader ecosystem of plugins and integrations. This API gives developers programmatic access to Talqui's services layer, exposing the operations needed to read and manage tenants, conversations, plugins, and related resources that power that platform. Authentication is available on behalf of an Operator (the default for this API), a Plugin Connection, or a Plugin — see the [Talqui authentication guide](https://docs.talqui.chat/guides/introduction/authentication/) for how each token is obtained and when to use it. Need help or have questions not covered here? Reach out to support@talqui.com. license: name: ISC url: https://opensource.org/license/isc-license-txt title: Talqui - Services API version: 0.65.0 servers: - description: Production url: https://services-api.talqui.chat security: [] tags: - name: Tenants - name: Settings - name: Analytics - name: Campaigns - name: Campaigns models - name: Contacts - name: Handoff links - name: Inboxes - name: Messages - name: Notifications - name: Sessions - name: Operators - name: Plugins - name: Setup - name: Uploads paths: /v1/tenants/{tenantID}/campaigns/{campaignID}/progress: get: tags: - Campaigns summary: Get campaign progress description: |- Read-only aggregate progress for a single campaign — same shape as the `campaign:dispatch:progress` socket event talqui-core-api's dispatch engine emits (campaigns backend epic, task 15), so a client can poll this as a drift-correction fallback whenever it may have missed a socket event (reconnect, tab refocus, periodic refresh, manual "atualizar" button) without needing to reconcile a different shape. Works standalone too — a client that never connects to the socket can track a campaign end-to-end using only this endpoint. operationId: GetCampaignProgressController parameters: - in: path name: tenantID required: true schema: type: string - in: path name: campaignID required: true schema: type: string responses: '200': content: application/json: schema: additionalProperties: false properties: campaignID: type: string campaignStatus: type: string canceled: type: number failure: type: number pending: type: number processing: type: number success: type: number total: type: number required: - campaignID - campaignStatus - total - pending - processing - success - failure - canceled type: object description: Response for status 200. '400': content: application/json: schema: properties: errors: items: oneOf: - $ref: '#/components/schemas/MissingTenantIDError' - $ref: '#/components/schemas/MissingCampaignIDError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- MissingTenantIDError (error_code 1001): tenantID absent from the URL. | MissingCampaignIDError (error_code 1741): campaignID absent from the URL. '401': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnauthorizedError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.' '403': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/ForbiddenError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: 'ForbiddenError (error_code 1004): operator token rejected upstream.' '404': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/CampaignNotFoundError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- CampaignNotFoundError (error_code 1740): no campaign matches for this tenant. '500': content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnknownError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- UnknownError (error_code 5999): Unexpected internal error not otherwise documented for this endpoint. security: - operatorAuth: [] components: schemas: MissingTenantIDError: additionalProperties: false properties: error: enum: - MissingTenantIDError type: string error_code: enum: - 1001 type: number message: example: tenantID is required. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object MissingCampaignIDError: additionalProperties: false properties: error: enum: - MissingCampaignIDError type: string error_code: enum: - 1741 type: number message: example: campaignID is required. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message type: object UnauthorizedError: additionalProperties: false properties: error: enum: - UnauthorizedError type: string error_code: enum: - 1003 type: number message: example: You are not authorized to perform this request. type: string statusCode: enum: - 401 type: number required: - statusCode - error - error_code - message type: object ForbiddenError: additionalProperties: false properties: error: enum: - ForbiddenError type: string error_code: enum: - 1004 type: number message: example: You do not have access to this resource. type: string statusCode: enum: - 403 type: number required: - statusCode - error - error_code - message type: object CampaignNotFoundError: additionalProperties: false properties: error: enum: - CampaignNotFoundError type: string error_code: enum: - 1740 type: number message: example: Campaign not found. type: string statusCode: enum: - 404 type: number required: - statusCode - error - error_code - message type: object UnknownError: additionalProperties: false properties: error: enum: - UnknownError type: string error_code: enum: - 5999 type: number message: example: For some unknown reason your request has not succeeded. type: string statusCode: enum: - 500 type: number required: - statusCode - error - error_code - message type: object securitySchemes: operatorAuth: bearerFormat: JWT description: >- Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as `Authorization: Bearer `. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.