Gerar relatórios de rentabilização

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Nota: a geração de relatórios personalizados não é suportada no Apigee hybrid. Problema conhecido: 355714868

Ao usar a funcionalidade Relatórios personalizados do Apigee, pode gerar relatórios para ver informações de rentabilização das suas APIs. Para gerar os relatórios, pode usar a IU do Apigee, a API stats ou a API queries, conforme descrito nas secções seguintes:

• Adicionar um relatório personalizado através da IU do Apigee
• API Stats
• API Queries (API de relatórios personalizados assíncronos)

Dimensões e métricas de rentabilização

O Apigee fornece as seguintes métricas e dimensões de rentabilização:

• Métricas e dimensões para transações que usam um proxy de API
• Métricas e dimensões para transações baseadas em taxas

Métricas e dimensões para transações que usam um proxy de API

As tabelas seguintes apresentam as x_apigee_mintng_*métricas e dimensões disponíveis para transações que usam um proxy de API:

• Métricas

  Nome na IU	Nome na API	Descrição
  Multiplicador de preços da API	x_apigee_mintng_price_multiplier	O fator (multiplicador) pelo qual o custo por transação é multiplicado.
  Partilha de receita do programador	x_apigee_mintng_dev_share	A quota do programador da app ou do AppGroup na receita de uma transação.
  Preço de rentabilização	x_apigee_mintng_price	Receita total de uma transação.
  Taxas de rentabilização	x_apigee_mintng_rate	Taxa cobrada por uma transação.

• Dimensões

  Nome na IU	Nome na API	Descrição
  ID do plano tarifário	x_apigee_mintng_rate_plan_id	O plano de taxas de rentabilização para o programador de apps.
  Moeda da receita	x_apigee_mintng_currency	Moeda da receita de transações.
  Transação bem-sucedida	x_apigee_mintng_tx_success	Estado da rentabilização da transação.

Nota:

• Para as transações que usam um proxy de API, também pode usar outras métricas e dimensões, juntamente com as métricas e as dimensões x_apigee_mintng_*.
• A interpretação de um valor de dimensão depende da métrica. Por exemplo, se selecionar a dimensão API Product, para uma transação baseada em taxas, o valor será o nome do produto API correspondente ao plano tarifário ao qual deve ser aplicada a taxa de configuração ou a taxa recorrente. No entanto, se selecionar a dimensão API Product para uma transação não baseada em taxas, o valor será o nome do produto API que contém os proxies API que estão a ser chamados.

Métricas e dimensões para transações baseadas em taxas

As tabelas seguintes apresentam as métricas e as dimensões disponíveis apenas para transações baseadas em taxas:

• Métricas

  Nome na IU	Nome na API	Descrição
  Taxas	taxas	Valor da taxa.

• Dimensões

  Nome na IU	Nome na API	Descrição
  Nome do grupo de apps	app_group_name	Nome do AppGroup ao qual as taxas se aplicam, se aplicável. Para programadores de apps, este campo está em branco.
  Tipo de taxa	fees_type	Tipo de taxa: taxa de configuração, taxa recorrente, recarga pré-paga ou reembolso. Esta dimensão vai ser null quando usada com qualquer métrica que não seja fees.
  Hora de criação da taxa	criado	Data/hora Unix em que a taxa foi adicionada para o programador de apps e o produto de API. Esta dimensão é null quando usada com qualquer métrica que não seja fees.
  Moeda da receita	x_apigee_mintng_currency	Moeda da taxa.
  Email do programador	developer_email	O programador da app ou o AppGroup a quem vai ser cobrada a taxa de configuração, as taxas recorrentes ou o recarregamento pré-pago.
  ID de programador / ID do grupo de apps	programador	ID do programador de apps registado no Apigee ou do AppGroup ao qual as taxas se aplicam. Este valor pode ser usado para cálculos de faturação.
  Produto de API	api_product	Produto API correspondente ao plano tarifário ao qual a taxa se aplica. O valor está vazio para alguns tipos de taxas, como a recarga pré-paga.
  ID do plano tarifário	x_apigee_mintng_rate_plan_id	O plano de taxas de rentabilização para o programador de apps. O valor está vazio para alguns tipos de taxas, como a adição de saldo pré-pago.
  Início do período	period_start	Início do período para o qual são cobradas taxas recorrentes. Por exemplo, para uma taxa mensal, este é o primeiro dia do mês. Esta dimensão é null quando usada com qualquer métrica que não seja fees.
  Fim do período	period_end	Fim do período para o qual são cobradas taxas recorrentes. Por exemplo, para uma taxa mensal, este é o último dia do mês. Esta dimensão é null quando usada com qualquer métrica que não seja fees.

Para ver descrições detalhadas destas métricas e dimensões, consulte a referência de métricas, dimensões e filtros do Analytics.

O exemplo de relatório personalizado seguinte apresenta a soma das taxas de rentabilização em todas as apps do programador:

Para cada app de programador, o exemplo mostra o custo total de todas as transações de 1-Apr-2021 to 15-Apr-2021. O custo é calculado com base nos preços de consumo, conforme configurado no seu plano tarifário. Tenha em atenção que, neste exemplo, a métrica (x_apigee_mintng_rate) é um campo de rentabilização, mas a dimensão (developer_app) é um campo de não rentabilização. Assim, com base nos seus requisitos, pode gerar relatórios com uma combinação de campos de rentabilização e não rentabilização.

Também pode limitar os resultados com base nas caraterísticas das métricas através de filtros.

Para ver as taxas recorrentes nos relatórios gerados, inclua no intervalo de datas selecionado o dia após o último dia do mês ou o dia após a data de validade da subscrição, uma vez que é nessa altura que são cobradas.

Exportar dados de estatísticas de rentabilização

No Apigee, não tem de realizar passos adicionais para exportar os dados de estatísticas de rentabilização. Se estiver a exportar dados de estatísticas, o Apigee exporta os seguintes campos de rentabilização juntamente com os dados de estatísticas normais. Quando as transações baseadas em taxas e as transações que usam um proxy de API são exportadas em conjunto, cada registo é exportado com as métricas e as dimensões comuns, com outras métricas e dimensões (não relacionadas) definidas como NULL.

Nota: consulte a página de exportação com o link na frase anterior para ver informações adicionais sobre estes valores.

Importante: o Apigee adiciona periodicamente novos campos e recomenda que não escreva código dependente que possa ser interrompido por novos campos.

• client_received_start_timestamp
• period_end
• period_start
• x_apigee_mintng_currency
• x_apigee_mintng_dev_share
• x_apigee_mintng_price
• x_apigee_mintng_price_multiplier
• x_apigee_mintng_rate
• x_apigee_mintng_rate_plan_id
• x_apigee_mintng_tx_success