Example API Usage Detail report—CRW

Custom Report Writer (CRW) allows you to build an API usage detail report. This report captures all Web services activities made in your company within the last 63 days.

About the API Usage Detail report

You can use the API usage detail report to assess all Web services activity made in your company over the last 63 days. This report is especially useful for determining who has made Web services requests to your company and the types of requests that were made.

This report allows you to double-check your Web services authorizations list to ensure that all necessary sender IDs are included in the list. You can also use this report to identify any unknown sender IDs and track their actions.

Open the custom report writer

1. Open Custom Report Writer in any of the following ways:

   • Go to Customization Services > All > Custom reports.

   • Go to Platform Services > All > Reports.

   • Go to Reports > All > Advanced > Custom reports.

2. Select Add to launch the Custom Report Writer Wizard (CRWZ) and begin creating a report.

Create an API usage detail report

You can create an API usage detail report to track users who made Web services requests to your company in the last 63 days.

We recommend creating the API usage detail report detailed below, as it contains the most useful columns of information. If your business has other needs, you can add or remove columns and change the sorting and filtering. See Use Custom Report Writer Wizard—CRWZ for more information about the specific steps.

1. Go to Reports > All > Reports and select Add (circle) next to Custom reports.
2. In Step 1: Select a primary data source, choose API usage detail.
3. In Step 2: Add columns, add the following columns:
   • Client type
   • DTD version
   • Function name
   • Login ID
   • No. of transaction
   • Partner ID
   • Status
   • When created
   Some companies find Control ID to be a useful column for tracking purposes. For more information about the different columns, see Column descriptions.
4. In Step 4: Select column sequence, drag and drop the columns into the order you want, and rename any columns as needed. The following sequence is recommended for the columns:
   • When created
   • Client type
   • DTD version
   • Login ID
   • Partner ID
   • Function name
   • Status
   • No. of transaction
5. In Step 6: Sort columns, choose Descending from the dropdown beside When created.
6. Optionally, in Step 9: Set report date and title, you add a Report title and Footer text.
7. In Step 11: Save and add to menu. Name your report. For example, Web services requests to my company or API usage detail.
   You can add your report to a menu by checking Add to menu and selecting an application from the Application dropdown menu. The report is added to the selected application.
8. Save your report.

Run the report

You can run the API usage detail report from the Reports center or the Custom reports list. See Run a Custom Report Writer report—CRW for more information.

Run from the Reports center

1. Go to Reports > All > Operational reports > Custom reports.
2. Find your custom report, then select Run at the end of the row.
3. In the popup window, select a Report type, such as HTML, then select OK.

Run from the Custom reports list

1. Depending on your subscriptions, go to one of the following:

   • Customization Services > All > Custom reports
   • Platform Services > All > Reports
2. Find your custom report, then select Run at the end of the row.
3. In the popup window, select a Report Type, such as Excel, then select OK.

Column descriptions

The following table lists the columns included on the API usage detail report.

API usage details report columns

Column	Description
When created	When the Web services request took place.
Client type	Indicates where the Web services request is coming from.
DTD version	Indicates whether a generic function (3.0) or an object-specific function (2.1) was used.
Login ID	The user ID that made the Web services request.
Partner ID	The sender ID that made the Web Services request. This option is the ID that you add to your Web Services authorizations to ensure that Web services activity continues uninterrupted.
Function name	The Web services request made to the company.
Status	Indicates whether the Web services request was a success or failure.
No. of transaction	The number of transactions made by the Web services request.