Управление отчетами

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Введение

Отчеты о монетизации позволяют получить доступ к конкретной информации об использовании и активности транзакций. Например, вы можете определить, какие приложения, разработчики, пакеты продуктов API или продукты API имели транзакционную активность в течение определенного диапазона дат. Благодаря монетизации вы можете создавать сводные или подробные отчеты, отслеживающие использование API.

Виды отчетов по монетизации

Вы можете создавать следующие типы отчетов о монетизации.

О хранении данных

В публичном облаке Apigee Edge сохранение данных монетизации является правом плана. Ознакомьтесь с правами на монетизацию на странице https://cloud.google.com/apigee/specsheets . Свяжитесь с отделом продаж Apigee, если вы хотите, чтобы данные о монетизации сохранялись по истечении периода действия права. Расширенное хранение данных активируется в момент запроса и не может быть активировано задним числом для включения данных раньше, чем исходный период хранения данных.

О дублирующих транзакциях

Если вы сравните отчеты о транзакциях монетизации с данными Google Analytics, вы можете заметить небольшое количество повторяющихся транзакций. Это ожидаемое поведение, поскольку система монетизации может обрабатывать несколько миллионов транзакций ежедневно, при этом многие транзакции обрабатываются параллельно в любой момент. В среднем около 0,1% транзакций могут быть дубликатами.

Изучение страницы «Отчеты о монетизации»

Откройте страницу «Отчеты о монетизации», как описано ниже.

Настройка отчета

Настройте отчет с помощью пользовательского интерфейса, как описано в следующих разделах.

Действия по настройке отчета

Настройте отчет с помощью пользовательского интерфейса Edge или Classice Edge.

Настройка отчета о выставлении счетов

Следуйте инструкциям по настройке отчета и введите следующую информацию на странице отчета:

Настройка отчета о предоплаченном балансе

Настройка отчета о доходах

Следуйте инструкциям по настройке отчета и введите следующую информацию на странице отчета:

Включение пользовательских атрибутов транзакций в сводные отчеты о доходах

Политики записи транзакций позволяют собирать данные настраиваемых атрибутов транзакций и включать эти настраиваемые атрибуты в сводные отчеты о доходах. Определите набор настраиваемых атрибутов по умолчанию, включенных в таблицы базы данных монетизации, задав свойство MINT.SUMMARY_CUSTOM_ATTRIBUTES для вашей организации.

Использование этой функции требует некоторого обдумывания и планирования, поэтому ознакомьтесь с приведенными ниже соображениями.

Если вы являетесь клиентом облака, обратитесь в службу поддержки Apigee Edge , чтобы настроить это свойство. Если вы являетесь клиентом Apigee Edge для частного облака, установите флаг с помощью запроса PUT к следующему API с учетными данными системного администратора.

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

В этом примере вызов API включает эту функцию и добавляет столбцы partner_id и tax_source в базу данных монетизации. Обратите внимание, что массив пользовательских атрибутов в вызове API закодирован в URL-адресе.

Рекомендации по включению пользовательских атрибутов транзакций в отчеты

• Убедитесь, что имена атрибутов вы хотите использовать, прежде чем создавать их с помощью API. Это имена столбцов в базе данных, и там всегда хранятся данные пользовательских атрибутов.
• В каждой политике записи транзакций имеется 10 доступных слотов настраиваемых атрибутов, как показано на следующем рисунке. Используйте одни и те же имена и позиции атрибутов для одних и тех же атрибутов во всех продуктах, которые будут включены в отчеты. Например, в следующей политике записи транзакций пользовательские атрибуты partner_id и tax_source занимают поля 4 и 5 соответственно. Это должно быть их имя и должность во всех политиках регистрации транзакций для продуктов, которые будут включены в отчеты.
  
  

Чтобы включить пользовательские атрибуты в сводный отчет о доходах после включения этой функции, используйте API отчета, добавив transactionCustomAttributes в MintCriteria . См. Параметры конфигурации критериев .

Настройка отчета об отклонениях (устарело)

Следуйте инструкциям по настройке отчета и введите следующую информацию на странице отчета:

Формирование и скачивание отчета

После создания отчета вы можете загрузить результаты отчета в формате CSV или zip-файла. Вы можете создать файл CSV или zip синхронно или асинхронно .

• Для синхронного отчета вы запускаете запрос отчета, и запрос блокируется до тех пор, пока сервер аналитики не предоставит ответ. Однако, поскольку отчету может потребоваться обработать большой объем данных (например, сотни ГБ), синхронный отчет может завершиться неудачей из-за тайм-аута.

  Уровень сводного отчета поддерживает только синхронное создание.

• Для асинхронного отчета вы запускаете запрос отчета и получаете результаты позже. Некоторые ситуации, когда асинхронная обработка запросов может быть хорошей альтернативой, включают:

  • Анализ и создание отчетов, охватывающих большие временные интервалы.
  • Анализ данных с различными размерностями группировки и другими ограничениями, которые усложняют запрос.
  • Управление запросами, когда вы обнаружите, что объемы данных для некоторых пользователей или организаций значительно увеличились.

  Уровень подробного отчета поддерживает асинхронное создание.

Чтобы создать и загрузить отчет в формате CSV или zip, выполните одну из следующих задач:

1. Откройте страницу «Отчеты».
2. Наведите курсор на отчет, который хотите загрузить.

3. В столбце «Изменено» выберите один из следующих вариантов:

   1. значок или значок (для сводного отчета). Отчет синхронно сохраняется в файл CSV или zip.
   2. Отправьте задание (для подробного отчета). Асинхронное задание запускается.

      1. Следите за статусом задания в столбце Изменено .

         Значок диска появляется, когда отчет готов к загрузке:

         
      2. После завершения задания щелкните значок диска , чтобы загрузить отчет.

Ниже приведен пример файла CSV для сводного отчета о счетах.

Редактирование отчета

Чтобы отредактировать отчет:

1. Откройте страницу «Отчеты» .
2. Наведите курсор на отчет, который хотите редактировать, и нажмите кнопку в меню действий.
3. При необходимости обновите конфигурацию отчета.
4. Нажмите Обновить отчет , чтобы сохранить обновленную конфигурацию отчета.

Удаление отчета

Чтобы удалить отчет:

1. Откройте страницу «Отчеты» .
2. Наведите курсор на отчет, который вы хотите удалить.
3. Нажмите в меню действий.

Управление отчетами по монетизации с помощью API

В следующих разделах описывается, как управлять отчетами о монетизации с помощью API.

Настройка отчета с помощью API

Чтобы настроить отчет для всей организации, отправьте запрос POST к /organizations/{org_name}/report-definitions .

Чтобы настроить отчет для конкретного разработчика, отправьте POST-запрос к /organizations/{org_name}/developers/{dev_id}/report-definitions , где {dev_id} — это идентификатор разработчика.

При оформлении запроса необходимо указать название и тип отчета. Тип может быть одним из следующих: BILLING , REVENUE , VARIANCE (устарело) или PREPAID_BALANCE . Кроме того, вы можете указать критерии в свойстве mintCriteria , которое дополнительно настраивает отчет. Существует широкий спектр критериев, которые вы можете указать. Это дает вам большую гибкость в настройке отчета. Вот некоторые вещи, которые вы можете указать в качестве критериев:

• Для отчета о выставлении счетов или предоплаченном балансе — месяц выставления счета для отчета.
• Для отчета о доходах — тип транзакций, охватываемых отчетом, например транзакции покупки, транзакции списания и возврат средств.
• Для отчета о предоплаченном балансе разработчик, к которому относится отчет.
• Для отчета о доходах — пакеты продуктов API (или пакеты API), продукты, тарифные планы и приложения, к которым применяется отчет.
• Для отчета о выручке или отклонении применимая валюта отчета.
• Для отчетов о выставлении счетов, предоплаченном балансе или отчетах о доходах независимо от того, является ли отчет сводным или подробным отчетом.
• Для сводного отчета о доходах включите в отчет настраиваемые атрибуты транзакций.

Полный список критериев отчета см. в разделе «Параметры конфигурации отчета» .

Например, ниже создается отчет о доходах, в котором обобщаются операции транзакций за июль 2015 года. Отчет включает в себя различные типы транзакций, указанные в transactionTypes , и применяется конкретно к пакету продуктов API платежей и продукту API платежей. Поскольку в определении отчета не указан конкретный разработчик или приложение, отчет применяется ко всем разработчикам и приложениям. А поскольку для currencyOption установлено значение LOCAL , каждая строка отчета будет отображаться с использованием валюты соответствующего тарифного плана. Кроме того, свойство groupBy указывает, что столбцы в отчете будут сгруппированы в следующем порядке: ПАКЕТ, ПРОДУКТ, РАЗРАБОТЧИК, ПРИЛОЖЕНИЕ и RATEPLAN (в отчете содержится название и идентификатор тарифного плана).

$ 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

Ниже создается подробный отчет о выставлении счетов, показывающий деятельность разработчика DEV FIVE за июнь 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

Просмотр конфигураций отчетов с помощью API

Вы можете просмотреть определенную конфигурацию отчета или все конфигурации отчета для организации. Вы также можете просмотреть конфигурации отчетов для отдельного разработчика.

Чтобы просмотреть конкретную конфигурацию отчета для организации, выполните запрос GET к /organizations/{org_name}/report-definitions/{report_definition_id} , где {report_definition_id} — это идентификатор конкретной конфигурации отчета (идентификатор возвращается в ответе). при создании конфигурации отчета). Например:

$ 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

Чтобы просмотреть все конфигурации отчетов для организации, отправьте запрос GET к /organizations/{org_name}/report-definitions .

Вы можете передать следующие параметры запроса для фильтрации и сортировки результатов:

Например, следующая команда возвращает конфигурации отчетов для организации и ограничивает получение максимум пятью конфигурациями отчетов:

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

Ответ должен выглядеть примерно так (показана только часть ответа):

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

Чтобы просмотреть конфигурации отчета для конкретного разработчика, отправьте запрос GET к /organizations/{org_name}/developers/{dev_id}/report-definitions , где {dev_id} — это идентификатор разработчика. При выполнении запроса вы можете указать описанные выше параметры запроса для фильтрации и сортировки данных.

Например, следующая команда возвращает конфигурации отчета для конкретного разработчика и сортирует ответ по имени отчета:

$ 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

Обновление конфигурации отчета с помощью API

Чтобы обновить конфигурацию отчета, отправьте запрос PUT к /organizations/{org_name}/report-definitions/{report_definition_id} , где {report_definition_id} — это идентификатор конкретной конфигурации отчета. При выполнении обновления необходимо указать в теле запроса обновленные значения конфигурации и идентификатор конфигурации отчета. Например, следующий запрос преобразует отчет в сводный отчет (обновленные свойства выделены):

$ 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

Ответ должен выглядеть примерно так (показана только часть ответа):

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

Удаление конфигурации отчета с помощью API

Чтобы удалить конфигурацию отчета, отправьте запрос DELETE на /organizations/{org_namer}/report-definitions/{report_definition_id} , где {report_definition_id} — это идентификатор удаляемой конфигурации отчета. Например:

$ 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

Создание отчета с помощью API

После настройки отчета вы можете создать его в формате файла со значениями, разделенными запятыми (CSV), для просмотра.

Чтобы создать отчет, отправьте POST-запрос organizations/{org_id}/{report_type} , где {report_type} указывает тип отчета, который вы хотите создать. Типы:

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

Например, чтобы создать отчет о выставлении счетов, отправьте POST-запрос organizations/{org_name}/billing-reports .

В теле запроса (для любого типа отчета) укажите критерии поиска отчета. Используйте свойства mintCriteria , чтобы указать критерии поиска. Дополнительные сведения см. в разделе «Параметры конфигурации критериев» .

Например, следующий запрос ищет отчет о доходах на основе различных критериев, таких как даты начала и окончания отчета и типы транзакций.

$ 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

Если он найден, отчет о доходах создается в формате файла CSV. Ниже приведен пример вывода отчета:

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,

Включение пользовательских атрибутов разработчика в отчеты о доходах с помощью API

Только для отчетов о доходах вы можете включать в отчет настраиваемые атрибуты, если настраиваемый атрибут определен для разработчика. Пользовательские атрибуты определяются при добавлении разработчиков в вашу организацию, как описано в разделе «Управление разработчиками приложений» .

Чтобы включить пользовательские атрибуты в отчет о доходах, отправьте POST-запрос organizations/{org_name}/revenue-reports и включите массив devCustomAttributes в тело запроса:

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

Примечание. Не указывайте предопределенные атрибуты MINT_* и ADMIN_* в массиве devCustomAttributes .

Например, следующий пример включает в отчет три настраиваемых атрибута: BILLING_TYPE , SFID и ORG_EXT (если они определены для разработчика):

$ 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

Ниже приведен пример выходных данных отчета, включающий значения для двух настраиваемых атрибутов:

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,

Отчетность о транзакционной активности с помощью API

Вы можете просмотреть транзакционную активность организации, отправив POST-запрос к /organizations/{org_name}/transaction-search . Когда вы делаете запрос, вам необходимо указать критерии для поиска. Вот некоторые вещи, которые вы можете указать в качестве критериев:

• Идентификатор одного или нескольких продуктов API, для которых были оформлены транзакции.
• Расчетный месяц и год совершения транзакций.
• Разработчик(и), выпустивший транзакцию.
• Тип транзакции, например комиссия за покупку и установку.
• Статус транзакции как успешный, так и неудачный.

Полный список критериев см. в разделе «Параметры конфигурации критериев» .

Например, следующие транзакции возврата, оформленные конкретным разработчиком за расчетный месяц июнь 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

Вы также можете определить, какие приложения, разработчики, пакеты продуктов API или продукты API выполняли транзакции в течение определенного диапазона дат. Вы просматриваете эту информацию отдельно для каждого типа объекта. Например, вы можете просмотреть информацию конкретно о приложениях, которые получают доступ к API в ваших пакетах продуктов API, монетизируемых в пределах указанной даты начала и окончания.

Чтобы просмотреть информацию о активности транзакций, отправьте GET-запрос к одному из следующих ресурсов:

При отправке запроса вам необходимо указать в качестве параметров запроса дату начала и дату окончания диапазона дат. Например, следующий запрос возвращает разработчиков с транзакциями за август 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

Ответ должен выглядеть примерно так (показана только часть ответа):

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

Параметры конфигурации отчета для API

Для API доступны следующие параметры конфигурации отчета:

Параметры конфигурации критериев

Следующие параметры конфигурации доступны для отчетов через свойство mintCriteria :

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

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