Gerenciar relatórios

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Introdução

Os relatórios de monetização permitem que você acesse informações de uso e atividade de transações focadas. Por exemplo, é possível determinar quais aplicativos, desenvolvedores, pacotes de produtos de API ou produtos de API tiveram atividades de transação em um determinado período. Com a monetização, você pode gerar relatórios resumo ou detalhados que acompanham o uso da API.

Tipos de relatórios de monetização

Você pode gerar os seguintes tipos de relatório 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 quiser que os dados de monetização sejam retidos além do período de direito. A retenção de dados estendida é ativada no momento da solicitação e não pode ser ativada retroativamente para incluir dados anteriores à janela de retenção de dados original.

Sobre transações duplicadas

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

Como explorar 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 dele:

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 dele:

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 e incluir esses atributos personalizados nos relatórios resumidos de receita. Para definir o conjunto padrão de atributos personalizados incluídos nas tabelas do banco de dados de monetização, defina a propriedade MINT.SUMMARY_CUSTOM_ATTRIBUTES para a organização.

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

Se você é um cliente da nuvem, entre em contato com o suporte do Apigee Edge para definir a propriedade. Se você for cliente do Apigee Edge para nuvem privada, defina a sinalização usando uma solicitação PUT para a API a seguir 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 é codificada por URL.

Considerações para incluir atributos de transação personalizados em relatórios

• Confirme 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 gravação de transações, como mostrado na imagem a seguir. Use exatamente os mesmos nomes e posições para os mesmos atributos em todos os produtos que serão incluídos nos relatórios. Por exemplo, na política de gravação de transações a seguir, os atributos personalizados partner_id e tax_source ocupam as caixas 4 e 5, respectivamente. Precisam ser o nome e a posição deles em todas as políticas de registro de transações para que os produtos sejam incluídos nos relatórios.
  
  

Para incluir atributos personalizados em um relatório de resumo de receita depois de ativar o recurso, use a API de relatórios adicionando transactionCustomAttributes a MintCriteria. Consulte Opções de configuração de critérios.

Como configurar um relatório de variações (descontinuado)

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

Como gerar e fazer o download de um relatório

Depois de criar um relatório, você poderá fazer o download dos resultados no formato de arquivo CSV ou ZIP. É possível gerar o arquivo CSV ou ZIP de maneira 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.

  O nível de relatório Resumo só é compatível com a 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

  O nível de relatório Detalhado é compatível com a geração assíncrona.

Para gerar e fazer o download de um relatório no formato de arquivo CSV ou zip, execute 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 de forma síncrona como um arquivo CSV ou ZIP.
   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. Após a conclusão do job, 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 do relatório.

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, envie uma solicitação POST para /organizations/{org_name}/report-definitions.

Para configurar um relatório para um desenvolvedor específico, envie 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, é necessário 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 na propriedade mintCriteria que configura o relatório ainda mais. Há uma grande variedade de critérios que você pode especificar. Isso oferece muita flexibilidade na configuração do relatório. Você pode especificar alguns itens como critérios:

• Em um relatório de faturamento ou de saldo pré-pago, o mês de faturamento do relatório
• Em um relatório de receita, o tipo de transações abordadas no relatório, como compras, cobranças e reembolsos.
• Em um relatório de saldo pré-pago, o desenvolvedor a quem ele se aplica
• Para um relatório de receita, são os pacotes de produtos de API (ou pacotes de API), produtos, planos de preços e aplicativos aos quais 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, de saldo pré-pago ou de receita, sejam eles resumidos ou detalhados.
• Para um relatório de resumo da receita, inclua atributos personalizados de transação.

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

Por exemplo, o código a seguir cria um relatório de receita que resume a atividade de transação 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 da API Payment e ao produto da API Payment. Como nenhum desenvolvedor ou aplicativo específico foi especificado na definição do relatório, ele se aplica a todos os desenvolvedores e aplicativos. Além disso, como a propriedade currencyOption está definida como LOCAL, cada linha do relatório será exibida usando a moeda do plano de tarifas aplicável. Além disso, a propriedade groupBy especifica que as colunas no relatório serão agrupadas na seguinte ordem: PACKAGE, PRODUCT, DESENVOLVEDOR, APPLICATION e RATEPLAN (inclui o nome e ID do plano de tarifas 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

Veja a seguir a criação de 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

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

Para conferir a configuração de um relatório específico de 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 do relatório específico (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 acessar todas as configurações de relatório da organização, envie uma solicitação GET para /organizations/{org_name}/report-definitions.

Transmita os seguintes parâmetros de consulta para filtrar e classificar os resultados:

Por exemplo, o comando a seguir retorna as configurações do relatório da organização e limita a recuperação a um máximo de cinco configurações:

$ 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 conferir 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, 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 de 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 a configuração de um relatório usando a API

Para atualizar uma configuração de 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, especifique os valores de configuração atualizados e o ID da configuração do relatório no corpo da solicitação. 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"
}

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

Após configurar um relatório, é possível gerá-lo no formato de arquivo de valores separados por vírgulas (CSV, na sigla em inglês) 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 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, envie 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 do relatório. Use as 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 procura 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 a API

Somente para relatórios de receita, é possível incluir atributos personalizados no relatório se o atributo personalizado estiver definido para o desenvolvedor. Você define atributos personalizados ao adicionar desenvolvedores à organização, conforme descrito em Como gerenciar desenvolvedores de apps.

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

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

Observação:não especifique os atributos predefinidos MINT_* e 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 atributos personalizados:

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 ver a atividade de transações de uma organização emitindo uma solicitação POST para /organizations/{org_name}/transaction-search. Ao fazer a solicitação, é necessário especificar critérios para a recuperação. Você pode especificar alguns itens como critérios:

• 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 da transação, como compra e taxas de configuração.
• Status da transação como bem-sucedida e com falha.

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

Por exemplo, o comando a seguir retorna as transações emitidas por um desenvolvedor específico no mês de faturamento de 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 tiveram atividades de transação em um determinado período. Essas informações são exibidas separadamente para cada tipo de objeto. Por exemplo, é possível ver informações especificamente 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 ver informações sobre a atividade da 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 uma data de início e uma de término para o período. Por exemplo, a solicitação a seguir retorna desenvolvedores com transações durante 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 seguintes opções de configuração estão disponíveis para relatórios pela propriedade mintCriteria:

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

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