Etapas do Pipeline
As etapas de um pipeline, com a quantidade e o valor das oportunidades que estão em cada uma agora. Os dois endpoints exigem pipelines:read.
As etapas também vêm embutidas em Listar pipelines e Buscar pipeline; use estes dois quando precisar dos totais por etapa, ou para resolver um único stage_id.
Listar etapas
GET/external/v1/pipelines/:id/stagesEtapas ordenadas do pipeline. opportunities_count e total_value são os mesmos números das colunas do Kanban do CRM: os cards que estão na etapa agora, em qualquer estado. Para o funil ativo por etapa (só cards abertos, com a contagem de perdidos) use o relatório de funil.
curl --request GET \
--url "https://app.getraze.com/external/v1/pipelines/pipe_01/stages" \
--header "X-API-Key: YOUR_API_KEY"{
"success": true,
"data": [
{
"id": "stg_new",
"pipeline_id": "pipe_01",
"name": "Novo",
"color": "gray",
"position": 0,
"is_win_stage": false,
"is_loss_stage": false,
"opportunities_count": 12,
"total_value": 48000
},
{
"id": "stg_won",
"pipeline_id": "pipe_01",
"name": "Ganho",
"color": "green",
"position": 5,
"is_win_stage": true,
"is_loss_stage": false,
"opportunities_count": 3,
"total_value": 27500
}
]
}| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da etapa (o stage_id das oportunidades) |
pipeline_id | string | Pipeline da etapa |
name | string | Nome da etapa |
color | string | Dica de apresentação para UI |
position | integer | Ordem dentro do pipeline; oportunidades criadas sem stage_id vão para a primeira |
is_win_stage | boolean | Mover um card para cá marca como ganho (won_at) |
is_loss_stage | boolean | Mover um card para cá marca como perdido (lost_at) |
opportunities_count | integer | Oportunidades que estão na etapa agora |
total_value | number | Soma do value dessas oportunidades (moedas diferentes são somadas como estão) |
Buscar etapa
GET/external/v1/pipelines/:id/stages/:stageIdUma etapa do pipeline, com pipeline_name e os mesmos totais. Use para resolver um stage_id que veio do histórico da oportunidade sem baixar todos os pipelines. Como Buscar pipeline, resolve etapas de pipelines inativos ou escondidos.
curl --request GET \
--url "https://app.getraze.com/external/v1/pipelines/pipe_01/stages/stg_won" \
--header "X-API-Key: YOUR_API_KEY"{
"success": true,
"data": {
"id": "stg_won",
"pipeline_id": "pipe_01",
"pipeline_name": "Vendas",
"name": "Ganho",
"color": "green",
"position": 5,
"is_win_stage": true,
"is_loss_stage": false,
"opportunities_count": 3,
"total_value": 27500
}
}Erros
| Status | Código | Descrição |
|---|---|---|
| 400 | VALIDATION_ERROR | id ou stageId não é um UUID |
| 403 | INSUFFICIENT_PERMISSIONS | A chave não tem pipelines:read |
| 404 | NOT_FOUND | Nenhum pipeline com este id na sua conta, ou a etapa não pertence a este pipeline |