You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Update a report definition

Resource Summary

Security

Content Type

application/json

Category

Reports,

Update a report definition

PUT

Update a report definition

Update a report definition. See also Updating a report definition using the API.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/report-definitions/{report_definition_id}

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "description": { "type": "string", "description": "Description of the report definition." }, "developer": { "type": "string", "description": "Developer ID or null." }, "id": { "type": "string", "description": "ID of the report definition." }, "name": { "type": "string", "description": "Name of the report definition." }, "type": { "type": "string", "description": "Type of report definition. Valid values include: BILLING, PREPAID_BALANCE, REVENUE, and VARIANCE." }, "mintCriteria": { "properties": { "appCriteria": { "type": "string", "description": "ID and organization for a specific application to be included in the report. If this property is not specified, all applications are included in the report." }, "asXorg": { "type": "string", "description": "TBD" }, "billingMonth": { "type": "string", "description": "Billing month of the report, such as JULY. Note: This property is not valid for revenue reports." }, "billingYear": { "type": "string", "description": "Billing year for the report, such as 2015. Note: This property is not valid for revenue reports." }, "currCriteria": { "type": "string", "description": "ID and organization for a specific currency to be included in the report. If this property is not specified, all supported currencies are included in the report." }, "currencyOption": { "type": "string", "description": "Currency for the report. Valid values include:
  • LOCAL: Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.
  • EUR: Local currency transactions are converted and displayed in Euros.
  • GPB: Local currency transactions are converted and displayed in United Kingdom pounds.
  • USD: Local currency transactions are converted and displayed in United States dollars.

Note: If you select EUR, GBP, or USD, the report displays all transactions using that single currency, based on the exchange rate in effect on the date of the transaction." }, "devCriteria": { "type": "string", "description": "Developer ID or email address, and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report." }, "devCustomAttribute": { "type": "object", "description": "Custom attributes to include in the report, if defined for a developer. Note: This property is not valid for revenue reports. Do not specify the predefined MINT_* and ADMIN_* attributes in the devCustomAttributes array.", "properties": {} }, "fromDate": { "type": "string", "description": "Starting date and time of the report in UTC time. For example: 2017-01-15 01:30:00. If the timestamp is not specified it defaults to 00:00:00. Note: This property applies only to revenue and variance reports." }, "groupBy": { "type": "array", "description": "Order in which sections are grouped in the report. Enter the values in the desired order: APPLICATION, BALANCE, DEVELOPER, ORG, PACKAGE, PRODUCT, and RATEPLAN.", "items": { "type": "string" } }, "monetizationPackageIds": { "type": "array", "description": "ID of one or more API packages to include in the report. If this property is not specified, all API packages are included in the report.", "items": { "type": "string" } }, "pkgCriteria": { "type": "string", "description": "ID and organization for a specific API package to be included in the report. If this property is not specified, all API packages are included in the report. This property can be specified instead of the monetizationpackageIds property." }, "prevFromDate": { "type": "string", "description": "Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report. Note: This property applies only to variance reports." }, "prevToDate": { "type": "string", "description": "Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report. Note: This property applies only to variance reports." }, "prodCriteria": { "type": "string", "description": "ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the productIds property." }, "productIds": { "type": "array", "description": "ID of one or more API products to include in the report. If this property is not specified, all API products are included in the report.", "items": { "type": "string" } }, "pricingTypes": { "type": "string", "description": "Pricing type of rate plan to be included in the report. Valid values include:

  • REVSHARE: Revenue share plan.
  • REVSHARE_RATECARD: Revenue share and rate card rate plan.
  • RATECARD: Rate card plan.

If this property is not specified, rate plans of all pricing types are included in the report.

" }, "ratePlanLevels": { "type": "string", "description": "Type of rate plan to be included in the report. Valid values include:
  • DEVELOPER: Developer rate plan.
  • STANDARD: Standard rate plan.

If this property is not specified, both developer-specific and standard rate plans are included in the report.

" }, "showEntityId": { "type": "boolean", "description": "Flag that specifies whether the reports shows the entity ID." }, "showRevSharePct": { "type": "boolean", "description": "Flag that specifies whether the report shows revenue share percentages. " }, "showSummary": { "type": "boolean", "description": "Flag that specifies whether the report is a summary." }, "showTxDetail": { "type": "boolean", "description": "Flag that specifies whether the report shows transaction level details.

Note: This property applies only to revenue reports.

" }, "showTxType": { "type": "boolean", "description": "Flag that specifies whether the report shows the type of each transaction. " }, "toDate": { "type": "string", "description": "Ending date and time of the report in UTC time. For example: 2017-01-15 01:30:00. If the timestamp is not specified it defaults to 00:00:00. Note: This property applies only to revenue and variance reports." }, "transactionStatus": { "type": "string", "description": "Status of transactions to include in the report. Valid values include:SUCCESS. Successful transactions.
  • FAILED: Failed transaction.
  • FINAL: Transactions marked as final.
  • REVIEW: Transaction marked as under review.
" }, "transactionCustomAttributes": { "type": "string", "description": "Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports." }, "transactionTypes": { "type": "object", "description": "Type of transactions to be included in the report. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, RECURRINGFEES, and TRUEUP. TRUEUPs are transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month. If this property is not specified, all transaction types are included in the report.", "properties": {} } } } }

org_name Name of your organization. true

report_definition_id Report definition ID. true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)