Reporting

List all reports

Changed on

Lists all reports that are automatically generated on your marketplace.

get/reporting/v1/reports

Request

Query parameters

countinteger

The number of reports to return from the results

fromDatenumber

The report generation start date and time, in epoch time

startinteger

The lower bound index for the requested results

toDatenumber

The report generation end date and time, in epoch time

type'ACTIVE_UNCONVERTED_USERS' | 'APPLICATION_USAGE' | 'CANCELLED_ENTITLEMENTS' | 'COMPANIES_CSV' | 'CONTRACT_TERM' | 'CUSTOMERS_CSV' | 'CUSTOMER_ACQUISITION_BONUS' | 'CUSTOMER_RETENTION_BONUS' | 'FAILED_ORDERS' | 'FAILURE_INTEGRATION_EVENT' | 'FREE_TRIALS' | 'GENERAL_PERFORMANCE_REPORT' | 'INVOICES' | 'INVOICES_CSV' | 'MICROSOFT_RECONCILIATION' | 'MIGRATION_PRODUCT_DATA' | 'MOSI_ACQUISITION_BONUS' | 'MOSI_RETENTION_BONUS' | 'NOT_USED_APP' | 'ORDER_EDITIONS_CSV' | 'ORDER_PRODUCTS_CSV' | 'PAYMENTS_DETAIL_CSV' | 'PAYMENTS_OVERVIEW_CSV' | 'RECONCILIATION' | 'RE_CALCULATE_SUBSCRIPTION_PRICES' | 'SUSPENDED_PURCHASED' | 'TAXES' | 'TRANSACTIONS' | 'VOICE_CONN_CSV'

Report type

Response

Success

totalCountnumber

Total count of reports returned by API

Example response

{
  "reports": [
    {
      "createdDate": 12345,
      "endDate": 12345,
      "filename": "...",
      "id": 12345,
      "reportType": "COMPANIES_CSV",
      "startDate": 12345
    },
    {
      "createdDate": 12345,
      "endDate": 12345,
      "filename": "...",
      "id": 12345,
      "reportType": "CUSTOMERS_CSV",
      "startDate": 12345
    }
  ],
  "totalCount": 12345
}

Changes