--- title: "Documentação da API | Apollo" description: "Referência da API REST do Apollo em OpenAPI: autenticação, chamados, apontamentos, dashboards e o formato de dados dos gráficos." url: https://www.apollohub.app/docs lang: pt-BR updated: 2026-11-13 --- # Documentação da API do Apollo Referência da API REST do Apollo, gerada da especificação OpenAPI. A especificação completa está em [api-docs-spec.yaml](https://static.apollohub.app/api-docs-spec.yaml). Carregando a referência interativa... ```json // Formato dos dados de cada tipo de gráfico // Para a implementação de web-workers, é necessário implementar um endpoint que retorne os dados no formato JSON abaixo // dependendo do tipo de gráfico que será exibido no dashboard. O endpoint deve estar configurado para aceitar requisições // Gráfico de Área (tipo: area) { "data": { "enableDataLabels": true, // Opcional: true ou false "enableLegend": false, // Opcional: true ou false "categories": ["Janeiro", "Fevereiro", "Março"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [ { "name": "Vendas", // Obrigatório: string (máx. 200 caracteres) "data": [150, 200, 250] // Obrigatório: array de números (mesmo tamanho de categories) }, { "name": "Despesas", "data": [100, 150, 200] } ] // Obrigatório: array de objetos } } // Gráfico de Linha (tipo: line) { "data": { "enableDataLabels": true, // Opcional: true ou false "enableLegend": false, // Opcional: true ou false "categories": ["Jan", "Fev", "Mar"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [ { "name": "Receita", // Obrigatório: string (máx. 200 caracteres) "data": [500, 700, 800] // Obrigatório: array de números (mesmo tamanho de categories) }, { "name": "Lucro", "data": [200, 300, 400] } ] // Obrigatório: array de objetos } } // Gráfico de Barra (tipo: bar) { "data": { "align": "left", // Opcional: "left" ou "right" "enableDataLabels": true, // Opcional: true ou false "enableLegend": false, // Opcional: true ou false "categories": ["Produto A", "Produto B", "Produto C"], // Obrigatório: array de strings (máx. 200 caracteres) "style": "stacked", // Obrigatório: "full", "normal" ou "stacked" "series": [ { "name": "Vendas", // Obrigatório: string (máx. 200 caracteres) "goals": [300, 400, 500], // Opcional: array de números "data": [250, 380, 450] // Obrigatório: array de números (mesmo tamanho de categories) }, { "name": "Meta", "goals": [500, 600, 700], "data": [450, 550, 650] } ] // Obrigatório: array de objetos } } // Gráfico de Coluna (tipo: column) { "data": { "style": "stacked", // Opcional: "normal", "stacked" ou "full" "align": "top", // Opcional: "top" ou "bottom" "categories": ["Janeiro", "Fevereiro", "Março"], // Obrigatório: array de strings (máx. 200 caracteres) "colors": ["#FF5733", "#33FF57", "#3357FF"], // Obrigatório: array de strings (cores hexadecimais válidas) "enableDataLabels": true, // Opcional: true ou false "enableLegend": false, // Opcional: true ou false "series": [ { "name": "Vendas", // Obrigatório: string (máx. 200 caracteres) "goals": [1000, 1200, 1500], // Opcional: array de números (ignorados se o estilo for "full" ou "stacked") "data": [800, 1000, 1200] // Obrigatório: array de números (mesmo tamanho de categories) }, { "name": "Lucro", "goals": [500, 600, 700], "data": [400, 500, 650] } ] // Obrigatório: array de objetos } } // Iframe (tipo: iframe) { "data": { "url": "https://www.exemplo.com" // Obrigatório: uma string válida de URL } } // Texto (tipo: text) { "data": { "content": "Este é um exemplo de conteúdo" // Obrigatório: string (máx. 5000 caracteres) } } // Gráfico Misto (tipo: mixed) { "data": { "categories": ["Janeiro", "Fevereiro", "Março"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [ { "name": "Vendas", // Obrigatório: string (máx. 200 caracteres) "type": "line", // Obrigatório: "line", "column" ou "area" "data": [800, 1000, 1200] // Obrigatório: array de números (mesmo tamanho de categories) }, { "name": "Lucro", "type": "column", "data": [400, 500, 650] } ] // Obrigatório: array de objetos } } // Gráfico de Área Polar (tipo: polarArea) { "data": { "categories": ["Categoria 1", "Categoria 2", "Categoria 3"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [120, 150, 200] // Obrigatório: array de números (mesmo tamanho de categories) } } // Gráfico de Pizza (tipo: pie) { "data": { "categories": ["Categoria A", "Categoria B", "Categoria C"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [50, 30, 20] // Obrigatório: array de números (mesmo tamanho de categories) } } // Gráfico de Barra Radial (tipo: radialBar) { "data": { "legend": "Legenda do gráfico", // Opcional: título da legenda (máx. 200 caracteres) "colors": ["#FF5733", "#33FF57"], // Opcional: array de cores hexadecimais válidas "categories": ["Categoria A", "Categoria B", "Categoria C"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [30, 40, 30] // Obrigatório: array de números (mesmo tamanho de categories) } } // Gráfico de Rosca (tipo: donut) { "data": { "categories": ["Categoria 1", "Categoria 2", "Categoria 3"], // Obrigatório: array de strings (máx. 200 caracteres) "series": [10, 20, 30] // Obrigatório: array de números (mesmo tamanho de categories) } } // Gráfico Treemap (tipo: treemap) { "data": { "series": [ { "name": "Série 1", // Obrigatório: string (máx. 200 caracteres) "value": 100 // Obrigatório: número }, { "name": "Série 2", // Obrigatório: string (máx. 200 caracteres) "value": 200 // Obrigatório: número } ] } } // Quantificador (tipo: quantifier) { "data": { "value": "100", // Obrigatório: string (máx. 200 caracteres) "color": "#ff5733" // Obrigatório: hexadecimal válido } } // Tabela (tipo: table) { "data": { "columns": ["Column 1", "Column 2"], // Obrigatório: array de strings (máx. 200 caracteres) "rows": [ { "color": "#ff5733", // Opcional: hexadecimal válido "cells": [ { "value": "Cell 1", "color": "#ffffff" }, // Opcional: hexadecimal válido { "value": "Cell 2", "color": "#ffffff" } ], "child": { "title": "Child Title", // Opcional: string "data": { // Estrutura recursiva para tabelas aninhadas } } } ] } } ``` ## Mapa do site - [Apollo: gestão de serviços de TI, chamados, horas e CRM](https://www.apollohub.app/index.md): Chamados com SLA, apontamento de horas com aprovação, CRM, finanças e dashboards no mesmo lugar, para empresas de serviços de TI. - [Ajuda e contato | Apollo](https://www.apollohub.app/contact.md): Fale com a equipe do Apollo pelo WhatsApp ou por email, peça uma proposta e encontre respostas para as dúvidas mais comuns. - [Documentação da API | Apollo](https://www.apollohub.app/docs.md): Referência da API REST do Apollo em OpenAPI: autenticação, chamados, apontamentos, dashboards e o formato de dados dos gráficos. - [Política de Cookies | Apollo](https://www.apollohub.app/legal/cookies.md): Quais cookies e tecnologias parecidas a Apollo usa, para quê, e como você controla cada um. - [Política de Privacidade | Apollo](https://www.apollohub.app/legal/privacy-policy.md): Como a Apollo coleta, usa e protege os dados pessoais de quem usa a plataforma. - [Segurança | Apollo](https://www.apollohub.app/legal/security.md): Os controles que protegem os dados da sua empresa, da infraestrutura ao acesso de cada usuário. - [Termos de Uso | Apollo](https://www.apollohub.app/legal/terms-of-service.md): As regras para usar a Apollo: o que esperamos de você e o que você pode esperar de nós.