2.0info: 1.0.6 analytics description: Serviço do Analytics do ERP XT. x-senior-domain: erpxt x-senior-domain-path: erpxt 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/erpxtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /analytics/queries/requestGeneralFilter: post: description: Filtrar dados nas páginas por empresa e filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/generalFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por empresa e filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/generalFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestAccountFilter: post: description: Filtrar dados nas páginas por contas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por contas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestSupplierGroupFilter: post: description: Filtrar dados nas páginas por grupo de fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por grupo de fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestReceiptFormFilter: post: description: Filtrar dados nas páginas por forma de recebimento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por forma de recebimento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getUserAnalytics: post: description: Return user analytics based on resources tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/userAnalytic minimum: 1 description: User Analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Return user analytics based on resources tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/userAnalytic minimum: 1 description: User Analytics 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/actions/requestUpload: post: description: Solicita o upload de arquivos para o blobservice da Senior tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName – customerCode properties: fileName: type: string description: Nome do arquivo customerCode: type: integer format: int64 description: Código do Cliente responses: 200: description: Ok schema: type: object required: – uploadUrl – fileVersion properties: uploadUrl: type: string description: Url onde deverá ocorrer o upload do arquivo fileVersion: type: string description: Versão gerada do arquivo 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/actions/commitFile: post: description: Confirma o arquivo no blobservice e retorna uma URL para realizar o download do arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName – fileVersion properties: fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – urlDownload properties: urlDownload: type: string description: URL de download do arquivo 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/actions/createSharedDatasets: post: description: Cria os datasets shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createSharedAnalytics: post: description: Cria os analytics shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createSharedPages: post: description: Cria as páginas shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumAnalytics: description: Analytics type: string enum: – FINANCIAL_DASHBOARD 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 userAnalytic: description: User Analytic type: object required: – analytic – pageId properties: analytic: type: string allOf: – #/definitions/enumAnalytics description: Analytic pageId: type: string description: PageId generalFilter: description: Record para filtro geral de empresa e filial type: object required: – companyCode – branchCode – branchName properties: companyCode: type: integer format: int64 description: Código empresa branchCode: type: integer format: int64 description: Código filial branchName: type: string description: Nome filial baseFilter: description: Record para filtros que possuem apenas um campo de resposta type: object required: – value properties: value: type: string description: Resultado da busca 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 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