Gerenciar relatórios

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

Com os relatórios de monetização, você acessa informações de uso e atividades de transações específicas. Por exemplo, é possível determinar quais aplicativos, desenvolvedores, pacotes de produtos de API ou produtos de API tiveram atividade de transação em um determinado período. Com a monetização, é possível gerar relatórios resumidos ou detalhados que rastreiam o uso da API.

Tipos de relatórios de monetização

Você pode gerar os seguintes tipos de relatórios de monetização.

Sobre a retenção de dados

Na nuvem pública do Apigee Edge, a retenção de dados de monetização é um direito do plano. Consulte os direitos de monetização em https://cloud.google.com/apigee/specsheets. Entre em contato com a equipe de vendas da Apigee se você quiser que os dados de monetização sejam retidos além do direito. período A retenção estendida de dados é ativada no momento da solicitação e não pode ser ativada de modo retroativo para incluir dados anteriores à janela original de retenção de dados.

Sobre transações duplicadas

Se você comparar os relatórios de transações de monetização com os dados do Analytics, notará uma pequena o número de transações duplicadas. Esse é o comportamento esperado, já que o sistema de monetização processar vários milhões de transações diariamente, com muitas transações processadas em paralelo a qualquer em um determinado momento. Em média, cerca de 0,1% das transações podem ser duplicadas.

Como usar a página "Relatórios de monetização"

Acesse a página "Relatórios de monetização", conforme descrito abaixo.

Como configurar um relatório

Configure um relatório usando a IU, conforme descrito nas seções a seguir.

Etapas para configurar um relatório

Configure um relatório usando a interface do Edge ou a interface do Classice Edge.

Como configurar um relatório de faturamento

Siga as etapas para configurar um relatório e insira as seguintes informações na página do relatório:

Como configurar um relatório de saldo pré-pago

Como configurar um relatório de receita

Siga as etapas para configurar um relatório e insira as seguintes informações na página do relatório:

Incluir atributos personalizados de transação em relatórios de resumo da receita

As políticas de registro de transações permitem capturar dados de atributos personalizados das transações. inclua esses atributos personalizados nos relatórios resumidos de receita. Defina o conjunto padrão de atributos personalizados incluídos nas tabelas do banco de dados de monetização definindo a propriedade MINT.SUMMARY_CUSTOM_ATTRIBUTES da organização.

Para usar esse recurso, é necessário pensar e planejar um pouco. Analise as considerações abaixo.

Se você é um cliente de nuvem, entre em contato com o suporte do Apigee Edge para definir o . Se você for cliente do Apigee Edge para nuvem privada, defina a sinalização usando uma solicitação PUT para a seguinte API com credenciais de administrador do sistema.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Neste exemplo, a chamada de API ativa o recurso e adiciona as colunas partner_id e tax_source ao banco de dados de monetização. A matriz de atributos personalizados na chamada de API é Codificado para URL.

Considerações sobre a inclusão de atributos de transações personalizadas nos relatórios

• Confira os nomes dos atributos que você quer usar antes de criá-los com a API. Esses são os nomes das colunas no banco de dados, e os dados de atributos personalizados são sempre armazenados lá.
• Há 10 slots de atributos personalizados disponíveis em cada política de registro de transações, conforme mostrado na imagem a seguir. Use exatamente os mesmos nomes e posições de atributos para os mesmos atributos nos produtos que serão incluídos nos relatórios. Por exemplo, no seguinte política de gravação de transações, os atributos partner_id e tax_source personalizados os atributos ocupam as caixas 4 e 5, respectivamente. Esse deve ser o nome e a posição do usuário em todas as políticas de gravação de transações para que os produtos sejam incluídos nos relatórios.
  
  

Para incluir atributos personalizados em um relatório de resumo da receita após ativar o recurso, use o método da API de relatórios adicionando transactionCustomAttributes o MintCriteria. Consulte Configuração de critérios .

Como configurar um relatório de variação (descontinuado)

Siga as etapas para configurar um relatório e insira as seguintes informações na página do relatório:

Como gerar e fazer o download de um relatório

Depois de criar um relatório, você pode fazer o download dos resultados em formato CSV ou ZIP. Você pode gerar o arquivo CSV ou ZIP de forma síncrona ou assíncrona.

• Para um relatório síncrono, você executa a solicitação de relatório, e a solicitação fica bloqueada até o servidor de análise retornar uma resposta. No entanto, como um relatório pode precisar processar uma grande quantidade de dados (por exemplo, centenas de GB), um relatório síncrono pode expirar.

  Um nível de relatório Resumo só aceita geração síncrona.

• Para um relatório assíncrono, você executa a solicitação de relatório e recupera os resultados posteriormente. Veja a seguir algumas situações em que o processamento de consulta assíncrona pode ser uma boa alternativa:

  • Análise e criação de relatórios que abrangem períodos longos
  • Análise de dados com uma variedade de dimensões de agrupamento e outras restrições que aumentam a complexidade da consulta
  • Gerenciamento de consultas quando você perceber que os volumes de dados aumentaram significativamente para alguns usuários ou organizações

  Um nível de relatório detalhado oferece suporte à geração assíncrona.

Para gerar e fazer o download de um relatório em formato CSV ou ZIP, realize uma das seguintes tarefas:

1. Acesse a página "Relatórios".
2. Posicione o cursor sobre o relatório que você quer transferir por download.

3. Na coluna Modificado, clique em:

   1. O ícone ou (para um relatório de resumo). O relatório é salvo em um arquivo CSV ou ZIP de forma síncrona.
   2. Enviar job (para um relatório detalhado). O job assíncrono é iniciado.

      1. Monitore o status do job na coluna Modificado.

         O ícone de disco aparece quando o relatório está pronto para download:

         
      2. Depois que o job for concluído, clique no ícone de disco para fazer o download do relatório.

Veja a seguir um exemplo de arquivo CSV para um relatório de faturamento resumido.

Como editar um relatório

Para editar um relatório:

1. Acesse a página "Relatórios".
2. Posicione o cursor sobre o relatório que você quer editar e clique em no menu de ações.
3. Atualize a configuração do relatório conforme necessário.
4. Clique em Atualizar relatório para salvar a configuração atualizada.

Como excluir um relatório

Para excluir um relatório:

1. Acesse a página "Relatórios".
2. Posicione o cursor sobre o relatório que você quer excluir.
3. Clique em no menu de ações.

Como gerenciar relatórios de monetização usando a API

As seções a seguir descrevem como gerenciar relatórios de monetização usando a API.

Como configurar um relatório usando a API

Para configurar um relatório para uma organização inteira, emita uma solicitação POST para /organizations/{org_name}/report-definitions.

Para configurar um relatório para um desenvolvedor específico, emita uma solicitação POST para /organizations/{org_name}/developers/{dev_id}/report-definitions, em que {dev_id} é a identificação do desenvolvedor.

Ao fazer a solicitação, você precisa especificar o nome e o tipo do relatório. O tipo é um dos seguintes: BILLING, REVENUE, VARIANCE (descontinuado) ou PREPAID_BALANCE. Além disso, é possível especificar critérios no mintCriteria que configura o relatório ainda mais. Há uma ampla variedade de critérios que podem ser especificados. Isso oferece muita flexibilidade na configuração do relatório. Você pode especificar alguns itens como critérios:

• Para um relatório de saldo de pagamento antecipado ou de faturamento, o mês de faturamento do relatório
• Para um relatório de receita, o tipo de transações incluído, como transações de compra, de cobrança e reembolsos
• Em um relatório de saldo pré-pago, o desenvolvedor a quem ele se aplica
• Para um relatório de receita, os pacotes de produtos da API (ou pacotes de API), produtos, planos de tarifas e aplicativos a que o relatório se aplica
• Para um relatório de receita ou variação, a moeda aplicável do relatório.
• Para relatórios de faturamento, saldo pré-pago ou receita, se o relatório é um resumo ou um relatório detalhado
• Para um relatório de resumo de receita, inclua atributos de transação personalizados

Consulte Opções de configuração de relatórios para uma lista completa das critérios do relatório.

Por exemplo, o código a seguir cria um relatório de receita que resume a atividade de transação para no mês de julho de 2015. O relatório inclui vários tipos de transação especificados na propriedade transactionTypes e se aplica especificamente ao pacote de produtos e ao produto da API Payment. Como nenhum desenvolvedor ou aplicativo específico foi especificado no relatório definição, o relatório se aplica a todos os desenvolvedores e aplicativos. Como a propriedade currencyOption está definida como LOCAL, cada linha do relatório será mostrada usando a moeda do plano de tarifas aplicável. Além disso, o groupBy especifica que as colunas do relatório serão agrupadas no a seguinte ordem: PACKAGE, PRODUTO, DESENVOLVEDOR, APLICATIVO e RATEPLAN (inclui o nome do plano de tarifação) e ID no relatório).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

O código a seguir cria um relatório de faturamento detalhado que mostra a atividade de um desenvolvedor DEV FIVE para junho de 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

Visualizar as configurações de relatórios usando a API

Você pode conferir uma configuração de relatório específica ou todas as configurações de relatório de uma organização. Também é possível conferir as configurações de relatórios de um desenvolvedor específico.

Para visualizar uma configuração de relatório específica para uma organização, envie uma solicitação GET para /organizations/{org_name}/report-definitions/{report_definition_id}, em que {report_definition_id} é a identificação da configuração específica do relatório (o ID é retornado na resposta quando você cria a configuração do relatório). Exemplo:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Para visualizar todas as configurações de relatório da organização, envie uma solicitação GET para /organizations/{org_name}/report-definitions:

É possível transmitir os seguintes parâmetros de consulta para filtrar e classificar os resultados:

Por exemplo, o comando a seguir retorna as configurações de relatório da organização e limita o até cinco configurações de relatório:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Para visualizar as configurações de relatório de um desenvolvedor específico, envie uma solicitação GET para /organizations/{org_name}/developers/{dev_id}/report-definitions, em que {dev_id} é a identificação do desenvolvedor. Ao fazer a solicitação, é possível especifique os parâmetros de consulta descritos acima para filtrar e classificar os dados.

Por exemplo, o comando a seguir retorna as configurações de relatório de um desenvolvedor específico e classifica a resposta por nome do relatório:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

Como atualizar uma configuração de relatório usando a API

Para atualizar a configuração de um relatório, emita uma solicitação PUT para /organizations/{org_name}/report-definitions/{report_definition_id}, em que {report_definition_id} é a identificação da configuração específica do relatório. Ao fazer a atualização, você precisa especificar no corpo da solicitação os valores de configuração atualizados e o ID da configuração do relatório. Por exemplo, a solicitação a seguir atualiza o relatório para um relatório de resumo (as propriedades atualizadas estão destacadas):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

Como excluir uma configuração de relatório usando a API

Para excluir uma configuração de relatório, emita uma solicitação DELETE para /organizations/{org_namer}/report-definitions/{report_definition_id}, em que {report_definition_id} é a identificação da configuração do relatório a ser excluída. Exemplo:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Como gerar um relatório usando a API

Depois de configurar um relatório, você pode gerar o relatório no formato de arquivo de valores separados por vírgulas (CSV) para visualização.

Para gerar um relatório, envie uma solicitação POST para organizations/{org_id}/{report_type}, em que {report_type} especifica o o tipo de relatório que você quer gerar. Os tipos são:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Por exemplo, para gerar um relatório de faturamento, emita uma solicitação POST para organizations/{org_name}/billing-reports.

No corpo da solicitação (para qualquer tipo de relatório), especifique os critérios de pesquisa. Use propriedades mintCriteria para especificar os critérios de pesquisa. Consulte Opções de configuração de critérios para mais detalhes.

Por exemplo, a solicitação a seguir pesquisa um relatório de receita com base em vários critérios, como datas de início e término do relatório e tipos de transação.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Se encontrado, o relatório de receita é gerado no formato de arquivo CSV. Confira a seguir um exemplo da saída do relatório:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Incluir atributos personalizados do desenvolvedor nos relatórios de receita usando o API

Para relatórios de receita, é possível incluir atributos personalizados, é definido para o desenvolvedor. Você define atributos personalizados ao adicionar desenvolvedores à sua organização, conforme descrito em Gerenciar desenvolvedores de apps.

Para incluir atributos personalizados em um relatório de receita, envie uma solicitação POST para organizations/{org_name}/revenue-reports e inclua o Matriz devCustomAttributes no corpo da solicitação:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Observação:não especifique os MINT_* e Atributos ADMIN_* na matriz devCustomAttributes.

Por exemplo, o exemplo a seguir inclui três atributos personalizados: BILLING_TYPE, SFID e ORG_EXT, no relatório (se definido) para o desenvolvedor):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Veja a seguir um exemplo de saída de relatório que inclui valores para os dois tipos atributos:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

Como informar atividades de transações usando a API

Você pode visualizar a atividade de transação de uma organização emitindo uma solicitação POST para /organizations/{org_name}/transaction-search: Ao fazer a solicitação, é necessário especificar os critérios para a recuperação. Algumas das coisas que você pode especificar como critérios são:

• ID de um ou mais produtos de API para os quais as transações foram emitidas.
• Mês e ano de faturamento das transações.
• Desenvolvedores que emitiram a transação.
• Tipo de transação, como taxas de compra e configuração.
• Status da transação como bem-sucedida e com falha.

Consulte Opções de configuração de critérios para conferir uma lista completa de critérios.

O exemplo a seguir retorna transações emitidas por um desenvolvedor específico para o faturamento Junho de 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Também é possível determinar quais aplicativos, desenvolvedores, pacotes de produtos de API ou produtos de API atividade de transação dentro de um determinado período. Você pode conferir essas informações separadamente para cada tipo de objeto. Por exemplo, é possível visualizar informações específicas sobre aplicativos que acessam APIs nos seus pacotes de produtos de APIs monetizadas dentro de uma data de início e de término especificada.

Para conferir informações sobre a atividade de transação, emita uma solicitação GET para um dos seguintes recursos:

Ao emitir a solicitação, você precisa especificar como parâmetros de consulta as datas de início e término para o período. Por exemplo, a solicitação a seguir retorna transações feitas pelos desenvolvedores durante o mês de agosto de 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

Opções de configuração de relatórios para a API

As seguintes opções de configuração de relatório estão disponíveis para a API:

Opções de configuração de critérios

As opções de configuração a seguir estão disponíveis para relatórios por meio da Propriedade mintCriteria:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]