Passar para o conteúdo principal

Como Coletar Dados de E-mails para Relatórios

Este artigo descreve as consultas (endpoints) disponíveis para coletar dados sobre e-mails e modelos de e-mail, que podem ser usadas para construir relatórios detalhados.

Product Team avatar
Escrito por Product Team
Atualizado essa semana

1. Consultar E-mails da Caixa de Entrada por Card (Público)

Esta consulta permite visualizar os e-mails associados a um card específico.

Finalidade: Olhar os e-mails que estão ligados a um determinado card.

  • Argumentos (Informações Necessárias):

    • card_id (ID, obrigatório): O código de identificação do card para o qual você deseja buscar os e-mails.

    • filter_by_current_user (Booleano, opcional): Se usado, filtra os e-mails para mostrar apenas os do usuário atual.

      Exemplo:

      graphql
           query {
             inboxEmails(cardId: "your_card_id") {
               edges {
                 node {
                   id
                   subject
                   body
                   sender
                   receivedAt
                 }
               }
             }
           }

    Dados Retornados: A consulta pode retornar as seguintes informações sobre os e-mails:

    1. id (identificador)

    2. subject (assunto)

    3. body (corpo do e-mail)

    4. sender (remetente)

    5. receivedAt (data de recebimento)

2. Obter Contagem de E-mails Enviados e Recebidos (Privado)

Esta consulta fornece a contagem total de e-mails enviados e recebidos para um cartão específico.

Finalidade: Saber o número total de e-mails enviados e recebidos associados a um card.

URL: graphql/core

  • Argumentos (Informações Necessárias):

    • card_id (ID, obrigatório): O código de identificação do card para o qual você deseja contar os e-mails.

Exemplo:

query GetSentAndReceivedCardEmailsCount($cardId: ID!) {
  card(id: $cardId) {
    sentAndReceivedCardEmailsCount
  }
}

3. Acessar Modelos de E-mail (Privado)

Esta consulta busca uma lista de modelos de e-mail disponíveis, permitindo filtrar por nome.

Finalidade: Obter uma lista de modelos de e-mail salvos em um repositório.

URL: graphql/core

  • Argumentos (Informações Necessárias):

    • repo_id (ID, obrigatório): O código de identificação do repositório de onde os modelos de e-mail devem ser buscados.

    • filter_by_name (String, opcional): Um texto que pode ser usado para filtrar os modelos pelo nome.

      Exemplo:

      query GetParsedEmailTemplate($emailTemplateId: ID!, $cardUuid: ID) {
        parsedEmailTemplate(emailTemplateId: $emailTemplateId, cardUuid: $cardUuid) {
          id
          name
          subject
          body
          fromEmail
          toEmail
          ccEmail
          bccEmail
          hasInsecureContent
        }
      }

    Dados Retornados: A consulta pode retornar os seguintes detalhes de cada modelo de e-mail:

    1. id (identificador)

    2. name (nome)

    3. subject (assunto)

    4. body (corpo do e-mail)

    5. fromEmail (e-mail do remetente)

    6. toEmail (e-mail do destinatário)

    7. ccEmail (e-mail em cópia)

    8. bccEmail (e-mail em cópia oculta)

    9. hasInsecureContent (indica se há conteúdo inseguro)

Respondeu à sua pergunta?