Skip to main content

Solutions

Products

Recommended products

Questions? We are here to help.
Contact us

Purchase

Questions? We are here to help.

Resources

API

List of API and Events reports

Events usage report

The Events report captures all relevant events for a given product within a specified timeframe. You can download this report using the
Download
 button. The report includes:
  • Message ID
  • Time
  • Product
  • Schema Display Name
  • Status
  • Reason
  • Correlation ID
  • Endpoint Name
  • Endpoint URL
The report captures events with the following status types:
  • Delivered
    : Successfully pushed into the webhook callback. You can filter to view only delivered events using the toggle button in the UI.
  • Delivery Failed
    : Encountered an error trying to push the event into the callback.
  • Queued
    : Event is queued for delivery and waiting to be sent to the callback.
  • No Subscribers Found
    : No callbacks found for the message; no subscribers for the event.
  • Internal Error
    : Various internal errors prevented distribution.

API usage report

The API Usage report is a consolidation of API traffic, latency, and errors on a product or list of products.
Create API Usage report
  1. Select
    Reports
    , then select the
    API Usage
     report link.
  2. Select
    Create Report
     to open the
    API Usage
     screen.
  3. Enter all report details, then select
    Create
    .
  4. Download the report within 7 days from the Actions column.
    note
    • Based on the start and end date, the report may take time to generate.
    • When a report is nearing the expiration date, a warning icon is displayed in the Download Expiration Date column.

Application History report

The Application History report details changes made to applications and permissions.
Download Application History report
  1. Select
    Reports
    , then select the
    Application History
     report link.
  2. Enter all report details, then select
    Submit
    .
  3. Select and choose your options:
    1. Download Application History Report - contains grouped information about API Products and respective changes made.
    2. Download Detailed Application History Report - contains information about individual API Products and changes made.
    3. Download All - Download both formats.
    note
    • You must download the report before moving away from the screen.
    • The Application History report does not maintain a history of reports generated.
    • You must create a new report each time you want to get application history details.

Application Permission report

The Application Permission report details application information and the associated API product permissions.
Download the Application Permission report
  1. Select
    Reports
    , then select the
    Application Permission
     report link.
  2. Enter the application name or select a product from the
    Products
     drop-down.
  3. Select
    Search
    .
    note
    You can also select
    Search
     without entering any information to pull up a list of all available reports.
  4. Select to download reports, or select the
    Y
     hyperlink under the product column, then download the report.

This article applies to:

  • PRODUCT: ONESOURCE API Administration