Administrar informes

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Introducción

Los informes de monetización te permiten acceder a información de uso específica y actividad de transacciones. Por ejemplo, puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacción durante un período determinado. Con la monetización, puedes generar informes de resumen o detallados que realicen un seguimiento del uso de la API.

Tipos de informes de monetización

Puedes generar los siguientes tipos de informes de monetización.

Acerca de la retención de datos

En la nube pública de Apigee Edge, la retención de datos de monetización es una autorización del plan. Consulta los derechos de monetización en https://cloud.google.com/apigee/specsheets. Comunícate con Ventas de Apigee si quieres que se retengan los datos de monetización después del período de autorización. La retención de datos extendida se activa en el momento de la solicitud y no se puede activar de forma retroactiva para incluir datos anteriores a la ventana de retención de datos original.

Exploración de la página Informes de monetización

Accede a la página Informes de monetización, como se describe a continuación.

Cómo configurar un informe

Configura un informe con la IU, como se describe en las siguientes secciones.

Pasos para configurar un informe

Configurar un informe con la IU de Edge o la IU de Edge clásica

Cómo configurar un informe de facturación

Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página correspondiente:

Cómo configurar un informe de saldo prepagado

Cómo configurar un informe de ingresos

Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página correspondiente:

Incluir atributos de transacción personalizados en los informes de resumen de ingresos

Las políticas de registro de transacciones te permiten capturar datos de atributos personalizados de las transacciones, y puedes incluirlos en los informes de ingresos de resumen. Para definir el conjunto predeterminado de atributos personalizados incluidos en las tablas de la base de datos de monetización, configura la propiedad MINT.SUMMARY_CUSTOM_ATTRIBUTES de tu organización.

El uso de esta función requiere consideración y planificación, por lo que debes revisar las siguientes consideraciones.

Si eres cliente de la nube, comunícate con el equipo de asistencia de Apigee Edge para configurar la propiedad. Si eres cliente de Apigee Edge para nube privada, configura la marca mediante una solicitud PUT a la siguiente API con credenciales de administrador del 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>"

En este ejemplo, la llamada a la API habilita la función y agrega las columnas partner_id y tax_source a la base de datos de monetización. Ten en cuenta que el array de atributos personalizados en la llamada a la API está codificada como URL.

Consideraciones para incluir atributos de transacción personalizados en los informes

• Asegúrate de saber qué nombres de atributos deseas usar antes de crearlos con la API. Esos son nombres de columnas en la base de datos, y los datos de atributos personalizados siempre se almacenan allí.
• Hay 10 ranuras de atributos personalizados disponibles en cada política de registro de transacciones, como se muestra en la siguiente imagen. Usa exactamente los mismos nombres y posiciones de atributos para los mismos atributos que se incluirán en los informes. Por ejemplo, en la siguiente política de registro de transacciones, los atributos personalizados partner_id y tax_source ocupan los cuadros 4 y 5, respectivamente. Debe ser su nombre y posición en todas las políticas de registro de transacciones para que los productos se incluyan en los informes.
  
  

Si quieres incluir atributos personalizados en un informe de ingresos de resumen después de habilitar la función, agrega transactionCustomAttributes a MintCriteria para usar la API de informes. Consulta Opciones de configuración de criterios.

Configuración de un informe de variación (obsoleto)

Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página correspondiente:

Cómo generar y descargar un informe

Después de crear un informe, puedes descargar sus resultados en formato de archivo CSV o ZIP. Puedes generar el archivo CSV o ZIP de forma síncrona o asíncrona.

• Para un informe síncrono, debes ejecutar la solicitud del informe y la solicitud se bloquea hasta que el servidor de estadísticas proporcione una respuesta. Sin embargo, como un informe podría necesitar procesar una gran cantidad de datos (por ejemplo, 100 de GB), un informe síncrono puede fallar debido a un tiempo de espera.

  El nivel de informe Resumen solo admite la generación síncrona.

• Para un informe asíncrono, debes ejecutar la solicitud del informe y recuperar los resultados más adelante. Algunos casos en los que el procesamiento de consultas asíncronas puede ser una buena alternativa incluyen los siguientes:

  • Análisis y creación de informes que abarquen intervalos grandes
  • Análisis de datos con una variedad de dimensiones de agrupación y otras restricciones que agregan complejidad a la consulta.
  • Administración de consultas cuando se descubre que los volúmenes de datos aumentaron de forma significativa para algunos usuarios u organizaciones.

  El nivel de informe Detallado admite la generación asíncrona.

Para generar y descargar un informe en formato de archivo CSV o ZIP, realice una de las siguientes tareas:

1. Accede a la página Informes.
2. Coloca el cursor sobre el informe que deseas descargar.

3. En la columna Modificado, haz clic en una de las siguientes opciones:

   1. El ícono o el ícono (para un Informe de resumen) El informe se guarda en un archivo CSV o ZIP de forma síncrona.
   2. Envía el trabajo (para obtener un informe detallado). Se inicia el trabajo asíncrono.

      1. Supervisa el estado del trabajo en la columna Modificado.

         Aparecerá el ícono del disco cuando el informe esté listo para descargar:

         
      2. Una vez que se haya completado el trabajo, haz clic en el ícono del disco para descargar el informe.

A continuación, se proporciona un ejemplo de archivo CSV para un informe de facturación de resumen.

Cómo editar un informe

Para editar un informe, siga estos pasos:

1. Accede a la página Informes.
2. Coloca el cursor sobre el informe que deseas editar y haz clic en en el menú de acciones.
3. Actualiza la configuración del informe según sea necesario.
4. Haz clic en Actualizar informe (Update report) para guardar la configuración actualizada del informe.

Cómo borrar un informe

Para borrar un informe, sigue estos pasos:

1. Accede a la página Informes.
2. Coloca el cursor sobre el informe que deseas borrar.
3. Haz clic en en el menú de acciones.

Administra los informes de monetización con la API

En las siguientes secciones, se describe cómo administrar los informes de monetización con la API.

Cómo configurar un informe mediante la API

Si deseas configurar un informe para toda una organización, envía una solicitud POST a /organizations/{org_name}/report-definitions.

Si quieres configurar un informe para un desarrollador específico, envía una solicitud POST a /organizations/{org_name}/developers/{dev_id}/report-definitions, en la que {dev_id} es la identificación del desarrollador.

Cuando realices la solicitud, deberás especificar el nombre y el tipo del informe. El tipo es uno de los siguientes: BILLING, REVENUE, VARIANCE (obsoleto) o PREPAID_BALANCE. Además, puedes especificar criterios en la propiedad mintCriteria que configura aún más el informe. Hay una gran variedad de criterios que puedes especificar. Esto te brinda mucha flexibilidad para configurar el informe. Estos son algunos de los elementos que puedes especificar como criterios:

• En el caso de un informe de saldo prepagado o de facturación, es el mes de facturación del informe.
• En el caso de un informe de ingresos, el tipo de transacciones que se incluyen en el informe, como transacciones de compra, cobros y reembolsos
• En el caso de un informe de saldo prepagado, el desarrollador a quien se aplica el informe
• En el caso de un informe de ingresos, los paquetes de productos de API (o paquetes de API), los productos, los planes de tarifas y las aplicaciones a las que se aplica el informe
• En el caso de un informe de ingresos o variación, es la moneda aplicable al informe.
• En el caso de los informes de facturación, saldo prepagado o ingresos, ya sea un informe de resumen o uno detallado
• Para obtener un informe de resumen de ingresos, incluye en el informe los atributos de transacción personalizados

Consulta Opciones de configuración de informes para obtener una lista completa de los criterios de informes.

Por ejemplo, lo siguiente crea un informe de ingresos que resume la actividad de las transacciones del mes de julio de 2015. El informe incluye una variedad de tipos de transacciones especificados en la propiedad transactionTypes y se aplica específicamente al paquete de productos de la API de Payment y al producto de la API de Payment. Debido a que no se especifica ningún desarrollador o aplicación en la definición del informe, el informe se aplica a todos los desarrolladores y aplicaciones. Además, como la propiedad currencyOption está configurada como LOCAL, cada línea del informe se mostrará con la moneda del plan de tarifas aplicable. Además, la propiedad groupBy especifica que las columnas del informe se agruparán en el siguiente orden: PACKAGE, PRODUCT, Developer, APPLICATION y RATEPLAN (incluye el nombre y el ID del plan de tarifas en el informe).

$ 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

A continuación, se crea un informe de facturación detallado que muestra la actividad de un desarrollador DEV FIVE para junio 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

Cómo ver la configuración de los informes mediante la API

Puedes ver una configuración de informe específica o todas las configuraciones de informes de una organización. También puedes ver configuraciones de informes de un desarrollador individual.

Para ver una configuración de informes específica de una organización, emite una solicitud GET a /organizations/{org_name}/report-definitions/{report_definition_id}, en la que {report_definition_id} es la identificación de la configuración del informe específica (el ID se muestra en la respuesta cuando creas la configuración del informe). Por ejemplo:

$ 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 ver todas las configuraciones de informes de la organización, emite una solicitud GET a /organizations/{org_name}/report-definitions.

Puedes pasar los siguientes parámetros de consulta para filtrar y ordenar los resultados:

En el siguiente ejemplo, se muestran configuraciones de informes para la organización y se limita la recuperación a un máximo de cinco configuraciones de informes:

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

La respuesta debería ser similar a la siguiente (solo se muestra una parte):

{
  "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 ver la configuración de informes de un desarrollador específico, emite una solicitud GET a /organizations/{org_name}/developers/{dev_id}/report-definitions, en la que {dev_id} es la identificación del desarrollador. Cuando realizas la solicitud, puedes especificar los parámetros de consulta descritos anteriormente para filtrar y ordenar los datos.

En el siguiente ejemplo, se muestran configuraciones de informes para un desarrollador específico y se ordena la respuesta por nombre del informe:

$ 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

Actualiza una configuración de informes con la API

Para actualizar una configuración de informes, emite una solicitud PUT a /organizations/{org_name}/report-definitions/{report_definition_id}, en la que {report_definition_id} es la identificación de la configuración del informe específica. Cuando realizas la actualización, debes especificar en el cuerpo de la solicitud los valores de configuración actualizados y el ID de la configuración del informe. Por ejemplo, la siguiente solicitud actualiza el informe a un informe de resumen (se destacan las propiedades actualizadas):

$ 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

La respuesta debería ser similar a la siguiente (solo se muestra una parte):

{
 "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"
}

Cómo borrar una configuración de informes mediante la API

Para borrar una configuración de informes, emite una solicitud DELETE a /organizations/{org_namer}/report-definitions/{report_definition_id}, en la que {report_definition_id} es la identificación de la configuración del informe que se borrará. Por ejemplo:

$ 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

Cómo generar un informe mediante la API

Después de configurar un informe, puedes generarlo en formato de archivo de valores separados por comas (CSV) para su visualización.

Para generar un informe, emite una solicitud POST a organizations/{org_id}/{report_type}, en la que {report_type} especifica el tipo de informe que deseas generar. Los tipos son los siguientes:

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

Por ejemplo, para generar un informe de facturación, envía una solicitud POST a organizations/{org_name}/billing-reports.

En el cuerpo de la solicitud (para cualquier tipo de informe), especifica los criterios de búsqueda del informe. Usa las propiedades mintCriteria para especificar los criterios de búsqueda. Consulta las Opciones de configuración de criterios para obtener más detalles.

Por ejemplo, la siguiente solicitud busca un informe de ingresos según varios criterios, como las fechas de inicio y finalización del informe y los tipos de transacciones.

$ 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

Si lo encuentras, se generará el informe de ingresos en formato de archivo CSV. A continuación, se muestra un ejemplo del resultado del informe:

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,

Inclusión de atributos personalizados de desarrolladores en los informes de ingresos a través de la API

Solo para los informes de ingresos, puedes incluir atributos personalizados en el informe si este está definido para el desarrollador. Defines atributos personalizados cuando agregas desarrolladores a tu organización, como se describe en Administra desarrolladores de apps.

Para incluir atributos personalizados en un informe de ingresos, envía una solicitud POST a organizations/{org_name}/revenue-reports y, luego, incluye el array devCustomAttributes en el cuerpo de la solicitud:

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

Nota: No especifiques los atributos predefinidos MINT_* y ADMIN_* en el array devCustomAttributes.

En el siguiente ejemplo, se incluyen tres atributos personalizados, BILLING_TYPE, SFID y ORG_EXT, en el informe (si está definido para el desarrollador):

$ 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

A continuación, se proporciona un ejemplo del resultado del informe que incluye valores para los dos 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,

Cómo informar la actividad de transacciones mediante la API

Puedes ver la actividad de transacciones de una organización si emites una solicitud POST a /organizations/{org_name}/transaction-search. Cuando realizas la solicitud, debes especificar los criterios de recuperación. Estos son algunos de los elementos que puedes especificar como criterios:

• Es el ID de uno o más productos de API para los que se emitieron transacciones.
• Mes y año de facturación de las transacciones
• Los desarrolladores que emitieron la transacción
• Es el tipo de transacción, como la compra y las tarifas de configuración.
• Es el estado de la transacción, como correcta y fallida.

Consulta las Opciones de configuración de criterios para obtener una lista completa de criterios.

Por ejemplo, lo siguiente muestra las transacciones emitidas por un desarrollador específico para el mes de facturación de junio 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

También puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacción en un período determinado. Esta información se ve por separado para cada tipo de objeto. Por ejemplo, puedes ver información específica sobre las aplicaciones que acceden a las APIs en tus paquetes de productos de API monetizados dentro de una fecha de inicio y finalización específica.

Para ver información sobre la actividad de transacciones, emite una solicitud GET a uno de los siguientes recursos:

Cuando emites la solicitud, debes especificar como parámetros de consulta una fecha de inicio y una de finalización para el período. Por ejemplo, la siguiente solicitud muestra los desarrolladores con transacciones durante el mes 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

La respuesta debería ser similar a la siguiente (solo se muestra una parte):

{
  "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"
  }, ...
  ]
}

Opciones de configuración de informes para la API

Las siguientes opciones de configuración de informes están disponibles para la API:

Opciones de configuración de criterios

Las siguientes opciones de configuración están disponibles para los informes a través de la propiedad mintCriteria:

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

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