Ajuda IntegraĆ§Ć£o Zap

ReferĆŖncia da API

šŸ“Š Dashboard

GET /v2/api/external/{apiId}/dash/ticketsAndTimes

DashTicketsAndTimes

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsAndTimes":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsAndTimes","operationId":"DashTicketsAndTimes","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsChannels

DashTicketsChannels

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsChannels":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsChannels","operationId":"DashTicketsChannels","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsEvolution

DashTicketsEvolution

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsEvolution":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsEvolution","operationId":"DashTicketsEvolution","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsEvolutionByValue

DashTicketsEvolutionByValue

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsEvolutionByValue":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsEvolutionByValue","operationId":"DashTicketsEvolutionByValue","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsEvolutionChannelsName

DashTicketsEvolutionChannelsName

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsEvolutionChannelsName":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsEvolutionChannelsName","operationId":"DashTicketsEvolutionChannelsName","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsPerUser

DashTicketsPerUser

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsPerUser":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsPerUser","operationId":"DashTicketsPerUser","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsQueue

DashTicketsQueue

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsQueue":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsQueue","operationId":"DashTicketsQueue","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsReasons

DashTicketsReasons

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsReasons":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsReasons","operationId":"DashTicketsReasons","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsStatus

DashTicketsStatus

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsStatus":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsStatus","operationId":"DashTicketsStatus","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/dash/ticketsUser

DashTicketsUser

{"openapi":"3.0.3","info":{"title":"Ajuda IntegraĆ§Ć£o Zap ā€” API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ“Š Dashboard"}],"servers":[{"url":"https://{baseUrl}","description":"InstalaĆ§Ć£o Ajuda IntegraĆ§Ć£o Zap do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Ajuda IntegraĆ§Ć£o Zap, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleĆ§Ć£o Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Ajuda IntegraĆ§Ć£o Zap.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/dash/ticketsUser":{"get":{"tags":["šŸ“Š Dashboard"],"summary":"DashTicketsUser","operationId":"DashTicketsUser","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"RequisiĆ§Ć£o processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}