2.0info: 3.0.0 Analytics description: Serviço de backend de análise de dados e Analytics Studio x-senior-domain: Diversidade e Inclusão x-senior-domain-path: diversity_inclusion x-senior-service-path: analytics 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/diversity_inclusionsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /analytics/queries/availableAnalyticsCharts: post: description: Retorna uma lista de relatórios do Analytics Studios disponíveis tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/availableAnalyticsChartsRecord minimum: 1 description: Lista de relatórios Analytics Studios disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de relatórios do Analytics Studios disponíveis tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/availableAnalyticsChartsRecord minimum: 1 description: Lista de relatórios Analytics Studios disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/listAvailableCnpjs: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataAvailableCnpjs description: Lista das UFs possíveis para o destino 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/dataAvailableCnpjs description: Lista das UFs possíveis para o destino 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /analytics/queries/executeDiagnosis: post: description: Retorna a execução dos datasets do diagnóstico tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – message properties: message: type: string format: byte description: Retorno das mensagens para o diagnóstico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a execução dos datasets do diagnóstico tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – message properties: message: type: string format: byte description: Retorno das mensagens para o diagnóstico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 /analytics/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 /analytics/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createComponents: post: description: Cria os componentes do Analytics Studio para Diversidade e Inclusão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createInsight: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – insightGeneratorId properties: insightGeneratorId: type: string description: Id do gerador de insight responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Insight gerado pela Inteligência Artificial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: 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 healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN availableAnalyticsChartsRecord: description: Relatórios do Analytics Studios disponíveis type: object required: – endpoint – name – description – icon properties: endpoint: type: string description: Link do Analytics Studios name: type: string description: Nome do relatório description: type: string description: Descrição do relatório icon: type: string description: Icone do relatório dataAvailableCnpjs: description: CNPJs type: object required: – cnpj properties: cnpj: type: string description: CNPJ 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. 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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