pipelines.forecast
Previsão de vendas por período. Baldes por dia, semana (segunda a domingo) ou mês, pela data prevista de fechamento: cards abertos com probabilidade (valor e valor ponderado valor × probabilidade) e, com includeWon, os ganhos pelo valor cheio. Perdidos nunca entram. Respeita o query do quadro; o status dele é ignorado.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/pipelines.forecast(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
crm:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
pipelines_forecast - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdpipelines.forecast)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
pipelineId | string (uuid) | sim | |
query | object | não | |
granularity | "day" | "week" | "month" | não | |
includeWon | boolean | não |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"pipelineId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"query": {
"type": "object",
"properties": {
"q": {
"type": "string",
"maxLength": 120
},
"attendantId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"attendantIds": {
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"cohort": {
"type": "string",
"maxLength": 64
},
"status": {
"type": "string",
"enum": [
"open",
"won",
"lost",
"all"
]
},
"filter": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"matcher": {
"type": "string",
"enum": [
"all",
"any"
]
},
"connector": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"maxLength": 60
},
"operator": {
"type": "string",
"maxLength": 30
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"maxItems": 500,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
{
"type": "null"
}
]
},
"lead": {
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 64
},
"order": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"field": {
"type": "string",
"maxLength": 60
},
"operator": {
"type": "string",
"maxLength": 30
},
"negation": {
"default": false,
"type": "boolean"
},
"parentId": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
]
},
"valueString": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"valueNumber": {
"type": [
"number",
"null"
]
},
"valueDate": {
"anyOf": [
{
"type": "string",
"maxLength": 40
},
{
"type": "null"
}
]
},
"valueBool": {
"type": [
"boolean",
"null"
]
},
"valueUuid": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"field",
"operator"
],
"additionalProperties": false
}
}
},
"required": [
"field",
"operator"
]
}
}
},
"required": [
"matcher",
"connector",
"conditions"
]
}
},
"priorities": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"low",
"normal",
"high",
"urgent"
]
}
},
"origins": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"tagIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"productIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"companyIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"contactIds": {
"maxItems": 500,
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"valueMinCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"valueMaxCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"expectedClosingDateFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"expectedClosingDateTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"cardOrder": {
"type": "string",
"enum": [
"manual",
"createdAtDesc",
"createdAtAsc",
"stageTimeAsc",
"stageTimeDesc"
]
}
}
},
"granularity": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"includeWon": {
"type": "boolean"
}
},
"required": [
"pipelineId"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/pipelines.forecast \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"pipelineId":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs pipelines.forecast --json '{"pipelineId":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta pipelines_forecast com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"buckets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"periodStart": {
"type": "string"
},
"openCount": {
"type": "number"
},
"openValue": {
"type": "number"
},
"openWeightedValue": {
"type": "number"
},
"wonCount": {
"type": "number"
},
"wonValue": {
"type": "number"
},
"forecastValue": {
"type": "number"
}
},
"required": [
"periodStart",
"openCount",
"openValue",
"openWeightedValue",
"wonCount",
"wonValue",
"forecastValue"
],
"additionalProperties": false
}
}
},
"required": [
"buckets"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).