Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
Obtener detalle de una campaña
curl --request GET \
  --url https://api-prod.studio.getsupervisor.ai/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "inputFileKey": "<string>",
  "totalRecords": 1,
  "processedRecords": 1,
  "successfulRecords": 1,
  "failedRecords": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "objective": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Path Parameters

​
campaignId
string<uuid>
required

Identificador de la campaña masiva

Response

Campaña encontrada.

​
campaignId
string<uuid>
required
​
workspaceId
string<uuid>
required
​
agentId
string<uuid>
required
​
agentVersionId
string<uuid>
required
​
name
string
required
Minimum string length: 1
​
status
enum<string>
required

Estado del procesamiento batch de la campaña.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
PARTIALLY_COMPLETED
​
inputFileKey
string
required

Ruta en storage del CSV original.

​
totalRecords
integer
required
Required range: x >= 0
​
processedRecords
integer
required
Required range: x >= 0
​
successfulRecords
integer
required
Required range: x >= 0
​
failedRecords
integer
required
Required range: x >= 0
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
objective
string | null

Objetivo opcional que se desea medir con la campaña.

​
startedAt
string<date-time> | null
​
completedAt
string<date-time> | null