2.0info: 2.2.0 customer_success description: Serviço de acompanhamento da jornada do cliente x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: customer_success contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /customer_success/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getMixpanelIntegration: post: description: Retorna a configuração da integração com o Mixpanel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: acronym: type: string description: Acrônimo do produto responses: 200: description: Ok schema: type: object allOf: – #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a configuração da integração com o Mixpanel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: acronym description: Acrônimo do produto in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/listTasks: post: description: Serviço para listar as tarefas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: skip: type: integer format: int64 description: Numero da página top: type: integer format: int64 description: Quantidade de registros por página name: type: string description: Filtrar por nome da tarefa productId: type: string description: Identificador do produto orderBy: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Resultado da chamada totalElements: type: integer format: int64 description: Quantidade de elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para listar as tarefas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: skip description: Numero da página in: query type: integer format: int64 – name: top description: Quantidade de registros por página in: query type: integer format: int64 – name: name description: Filtrar por nome da tarefa in: query type: string – name: productId description: Identificador do produto in: query required: true type: string – name: orderBy description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – content – totalElements properties: content: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Resultado da chamada totalElements: type: integer format: int64 description: Quantidade de elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTask: post: description: Serviço para busca uma tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da tarefa responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: Retorna uma tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para busca uma tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador da tarefa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: Retorna uma tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTotalTasks: post: description: Serviço para retornar quantidade de tarefas, ativadas, desativadas e executadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Identificador do produto responses: 200: description: Ok schema: type: object required: – total – active – disable – executed properties: total: type: integer format: int64 description: total de tarefas active: type: integer format: int64 description: Total de tarefas ativadas disable: type: integer format: int64 description: Total de tarefas desativadas executed: type: integer format: int64 description: Quantidade de tarefas executadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para retornar quantidade de tarefas, ativadas, desativadas e executadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Identificador do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – total – active – disable – executed properties: total: type: integer format: int64 description: total de tarefas active: type: integer format: int64 description: Total de tarefas ativadas disable: type: integer format: int64 description: Total de tarefas desativadas executed: type: integer format: int64 description: Quantidade de tarefas executadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTasksExecution: post: description: Serviço para acompanhar as tarefas que foram executadas e seus resultados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: skip: type: integer format: int64 description: Numero da página top: type: integer format: int64 description: Quantidade de registros por página productId: type: string description: Identificador do produto orderBy: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – totalElements – content properties: totalElements: type: integer format: int64 description: Quantidade de elementos encontrados content: type: array items: type: object allOf: – #/definitions/taskExecuted minimum: 1 description: Elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para acompanhar as tarefas que foram executadas e seus resultados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: skip description: Numero da página in: query type: integer format: int64 – name: top description: Quantidade de registros por página in: query type: integer format: int64 – name: productId description: Identificador do produto in: query required: true type: string – name: orderBy description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – content properties: totalElements: type: integer format: int64 description: Quantidade de elementos encontrados content: type: array items: type: object allOf: – #/definitions/taskExecuted minimum: 1 description: Elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getFunnel: post: description: Serviço para buscar um funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identifiador do funil responses: 200: description: Ok schema: type: object required: – funnel properties: funnel: type: object allOf: – #/definitions/funnel description: Retorna um funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para buscar um funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identifiador do funil in: query required: true type: string responses: 200: description: Ok schema: type: object required: – funnel properties: funnel: type: object allOf: – #/definitions/funnel description: Retorna um funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/listFunnels: post: description: Serviço para retorna uma lista de funils tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: skip: type: integer format: int64 description: Numero da página top: type: integer format: int64 description: Quantidade de registros por página name: type: string description: Nome do funil productId: type: string description: Identificador do produto orderBy: type: string description: Ordernação responses: 200: description: Ok schema: type: object required: – totalElements – content properties: totalElements: type: integer format: int64 description: Quantidade de elementos encontrados content: type: array items: type: object allOf: – #/definitions/funnel minimum: 1 description: elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para retorna uma lista de funils tags: – Queries x-senior-visibility: PUBLIC parameters: – name: skip description: Numero da página in: query type: integer format: int64 – name: top description: Quantidade de registros por página in: query type: integer format: int64 – name: name description: Nome do funil in: query type: string – name: productId description: Identificador do produto in: query required: true type: string – name: orderBy description: Ordernação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – content properties: totalElements: type: integer format: int64 description: Quantidade de elementos encontrados content: type: array items: type: object allOf: – #/definitions/funnel minimum: 1 description: elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/listFunnelsActive: post: description: Serviço para listar somente os funils ativos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Identificador do produto responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/funnel minimum: 1 description: Elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para listar somente os funils ativos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Identificador do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/funnel minimum: 1 description: Elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getFunnelData: post: description: Serviço para buscar os dados de utilização com base nas informações do funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – period properties: id: type: string description: Identificador do funil period: type: integer format: int64 description: Periodo responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/funnelData description: Dados de utilização do funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço para buscar os dados de utilização com base nas informações do funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do funil in: query required: true type: string – name: period description: Periodo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/funnelData description: Dados de utilização do funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTemplates: post: description: Retorna os templates do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – skip – top – productId properties: skip: type: integer format: int64 description: Numero da página top: type: integer format: int64 description: Quantidade de registros por página productId: type: string description: Código de identificação do produto responses: 200: description: Ok schema: type: object required: – elements – totalElements properties: elements: type: array items: type: object allOf: – #/definitions/templateManager minimum: 1 description: templates totalElements: type: integer format: int64 description: Total de elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os templates do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: skip description: Numero da página in: query required: true type: integer format: int64 – name: top description: Quantidade de registros por página in: query required: true type: integer format: int64 – name: productId description: Código de identificação do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – elements – totalElements properties: elements: type: array items: type: object allOf: – #/definitions/templateManager minimum: 1 description: templates totalElements: type: integer format: int64 description: Total de elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTemplatesActive: post: description: Retorna os templates do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Código de identificação do produto responses: 200: description: Ok schema: type: object required: – elements properties: elements: type: array items: type: object allOf: – #/definitions/templateManager minimum: 1 description: retorna os elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os templates do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Código de identificação do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – elements properties: elements: type: array items: type: object allOf: – #/definitions/templateManager minimum: 1 description: retorna os elementos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getTemplate: post: description: Busca um template pelo id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do template responses: 200: description: Ok schema: type: object required: – template properties: template: type: object allOf: – #/definitions/templateManager description: Retorna um template 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca um template pelo id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id do template in: query required: true type: string responses: 200: description: Ok schema: type: object required: – template properties: template: type: object allOf: – #/definitions/templateManager description: Retorna um template 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getUnsuccessfulFunnels: post: description: Busca os funis com menor taxa de finalização tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – product properties: period: type: integer format: int64 description: Período (em dias) em que os dados serão buscados default: 30 product: type: string description: Identificador do produto responses: 200: description: Ok schema: type: object required: – allUnfinishedFunnelCustomers – customersTotalUnfinished – funnels properties: allUnfinishedFunnelCustomers: type: array items: type: object allOf: – #/definitions/unfinishedFunnelCustomer minimum: 1 description: Todos os clientes que não completaram algum funil customersTotalUnfinished: type: integer format: int64 description: Total de clientes que não completaram algum funil funnels: type: array items: type: object allOf: – #/definitions/funnelRating minimum: 1 description: Funis com o número de clientes que concluiram 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os funis com menor taxa de finalização tags: – Queries x-senior-visibility: PUBLIC parameters: – name: period description: Período (em dias) em que os dados serão buscados in: query type: integer format: int64 – name: product description: Identificador do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – allUnfinishedFunnelCustomers – customersTotalUnfinished – funnels properties: allUnfinishedFunnelCustomers: type: array items: type: object allOf: – #/definitions/unfinishedFunnelCustomer minimum: 1 description: Todos os clientes que não completaram algum funil customersTotalUnfinished: type: integer format: int64 description: Total de clientes que não completaram algum funil funnels: type: array items: type: object allOf: – #/definitions/funnelRating minimum: 1 description: Funis com o número de clientes que concluiram 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/listCustomersOutOfFunnel: post: description: Lista os clientes que já logaram na plataforma nos últimos 30 dias, mas não estão em nenhum funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Identificador do produto period: type: integer format: int64 description: Período (em dias) em que os dados serão buscados default: 30 responses: 200: description: Ok schema: type: object required: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerOutOfFunnel minimum: 1 description: Clientes com conta digital que não estão em nenhum funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os clientes que já logaram na plataforma nos últimos 30 dias, mas não estão em nenhum funil tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Identificador do produto in: query required: true type: string – name: period description: Período (em dias) em que os dados serão buscados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerOutOfFunnel minimum: 1 description: Clientes com conta digital que não estão em nenhum funil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/exportMixpanelIntegrationProduct: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/newTask: post: description: Serviço para criar uma tarefa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: Tarefa responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da tarefa que foi criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/toggleTask: post: description: Serviço para ativar/desativar uma tarefa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – value properties: id: type: string description: Identificador da tarefa value: type: boolean description: true/false responses: 200: description: Ok schema: type: object required: – value properties: value: type: boolean description: Retorna se a task está ativada ou desativada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/deleteTask: post: description: Serviço para deletar uma tarefa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da tarefa responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: OK 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/newFunnel: post: description: Serviço para criar um funil tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – funnel properties: funnel: type: object allOf: – #/definitions/funnel description: Funil responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do funil que foi criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/newTemplate: post: description: Cria um template tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – template properties: template: type: object allOf: – #/definitions/templateManager description: template responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Retorna o id do template que foi criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/actions/importMixpanelIntegrationProduct: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/events/importMixpanelIntegrationProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /customer_success/events/exportMixpanelIntegrationProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /customer_success/entities/mixpanelIntegrationProduct: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mixpanelIntegrationProduct responses: 200: description: The created resource schema: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mixpanelIntegrationProduct responses: 200: description: The created resource schema: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/entities/mixpanelIntegrationProduct/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mixpanelIntegrationProduct responses: 200: description: Ok schema: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mixpanelIntegrationProduct responses: 200: description: Ok schema: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mixpanelIntegrationProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /customer_success/entities/mixpanelIntegrationProduct/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mixpanelIntegrationProduct responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN languageKind: description: Linguagems type: string enum: – EN_US – PT_BR – ES_US notificationKind: description: Tipos de notificação type: string enum: – NOTIFY_USER – EMAIL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status template: description: Template type: object required: – subject – content – language properties: id: type: string description: id subject: type: string description: Assunto content: type: string description: corpo do email language: type: string allOf: – #/definitions/languageKind description: Linguagem templateManager: description: Template Manager type: object required: – name – productId – kind – templates properties: id: type: string description: id name: type: string description: name productId: type: string description: productId active: type: boolean description: ativo default: true kind: type: string allOf: – #/definitions/notificationKind description: Tipo de notificação templates: type: array items: type: object allOf: – #/definitions/template minimum: 1 description: Templates endpoint: description: Endpoint type: object required: – name – domainName – serviceName properties: id: type: string description: Identificador do endpoint name: type: string description: Nome da primitiva domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço schedulerRepeat: description: Cron de agendamento no scheduler type: object required: – dayOfMonth – dayOfWeek – hour – minute – month properties: id: type: string description: Id da cron dayOfMonth: type: string description: Dia do mês dayOfWeek: type: string description: Dia da semana hour: type: string description: hora minute: type: string description: Minuto month: type: string description: Mês actionType: description: Acão da tarefa type: object required: – name – templateId properties: id: type: string description: Identificador da condição name: type: string description: Nome da ação templateId: type: string description: Template que será disparado quando uma ação for executada condition: description: Condições da tarefa type: object required: – endpoint – operator – value properties: id: type: string description: Identificador da condição endpoint: type: object allOf: – #/definitions/endpoint description: Endpoint operator: type: string description: Operador value: type: integer format: int64 description: Valor da condição task: description: Representa uma task que será executada pelo scheduler type: object required: – productId – name – description – schedulerRepeat – repetition – startDate – period – enable – conditions – actions properties: id: type: string description: Identificador da task scheduler: type: string description: Identificador da task salva no scheduler productId: type: string description: Identificador do produto name: type: string description: Nome da task description: type: string description: Descrição da task schedulerRepeat: type: object allOf: – #/definitions/schedulerRepeat description: Cron de agendamento no scheduler repetitionType: type: string description: Tipo de repetição repetition: type: string description: Repetição startDate: type: string format: date-time description: Data que inicio period: type: integer format: int64 description: Periodo de consulta enable: type: boolean description: Define se a task está ativada conditions: type: array items: type: object allOf: – #/definitions/condition minimum: 1 description: Condições que devem ser avaliadas quando uma task for executada actions: type: array items: type: object allOf: – #/definitions/actionType minimum: 1 description: Ação que devem ser executas quando uma task obter resultados taskExecuted: description: Representa uma task executada type: object required: – id – name – tenants – start properties: id: type: string description: Id da task que foi executada name: type: string description: Nome da task que foi executada tenants: type: array items: type: string minimum: 1 description: Tenants que foram encontrados start: type: string format: date-time description: Data que a task foi executada funnel: description: Representa um funil type: object required: – name – productId – enable – steps properties: id: type: string description: Id do funil name: type: string description: Nome do funil productId: type: string description: Identificador do produto enable: type: boolean description: Identifica se o funil está ativo steps: type: array items: type: object allOf: – #/definitions/step minimum: 1 description: Lista de passos do funil step: description: Representa um passo no funil type: object required: – name – position – endpoint properties: id: type: string description: Id do passo name: type: string description: Nome do passo position: type: integer format: int64 description: Identifica a posição do passo no funil endpoint: type: object allOf: – #/definitions/endpoint description: Endpoint adicionado ao passo funnelData: description: Representa um funil de utilização type: object required: – id – productId – name – data properties: id: type: string description: Id do funil productId: type: string description: Identificador do produto name: type: string description: Nome do funil data: type: array items: type: object allOf: – #/definitions/stepData minimum: 1 description: Passos do funil stepData: description: Representa um passo type: object required: – id – name – position – data properties: id: type: string description: Id do passo name: type: string description: Nome do passo position: type: integer format: int64 description: Identifica a posição do passo no funil data: type: array items: type: object allOf: – #/definitions/stepRecords minimum: 1 description: Dados do passo stepRecords: description: Representa um registro de um passo type: object required: – name – size properties: name: type: string description: nome do registro size: type: integer format: int64 description: Quantidade de vezes que foi encontrado funnelRating: description: Representa um funil com a taxa de finalização type: object required: – id – name – unfinishedFunnelCustomers – individualPercentageShare – customers properties: id: type: string description: Identificador do funil name: type: string description: Nome do funil unfinishedFunnelCustomers: type: integer format: int64 description: Número de clientes que não finalizaram o funil individualPercentageShare: type: integer format: int64 description: Percentual de clientes que não finalizaram o funil customers: type: array items: type: string minimum: 1 description: Clientes que não chegaram ao final do funil customerOutOfFunnel: description: Cliente que ainda não utilizou o produto type: object required: – id – name – cnpj – phone – tenant – domainName properties: id: type: string description: Identificador do cliente name: type: string description: Nome do cliente cnpj: type: string description: CNPJ do cliente phone: type: string description: Número do telefone do cliente tenant: type: string description: Nome do tenant do cliente domainName: type: string description: Nome do domínio do cliente unfinishedFunnelCustomer: description: Cliente que não finalizou o funil type: object required: – tenantName – funnelName properties: tenantName: type: string description: Nome do tenant funnelName: type: string description: Nome do funil mixpanelIntegrationProduct: description: Representa as informações de entegração de um produto com o Mixpanel type: object required: – acronym – mixpanelId – productName properties: id: type: string format: uuid description: Identificador único da integração acronym: type: string description: Acrônimo do produto mixpanelId: type: string description: Identificador do projeto do produto no Mixpanel productName: type: string description: Nome do produto notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE