API Usage Reports
Useful information to help you understand your API usage report
Filters
- Client Name: The Client making the API requests. This filter "listens" to the date range filter, so if a Client has not made a request within the date range, they will not appear as an option.
- Date Range: The date range in which the API requests were "created" or made. e.g changing this filter to being "year to date" will only produce an aggregation on API requests made within the current year.
API Company Summary for UK and IE.
Provides a record of successful API calls to the chargeable API action `company_get_data` for UK and Irish companies.
|
Field Name |
Definition |
|
Client Name |
Company Watch's Client Account Name |
|
Reg Number / CW_ID |
The unique Companies House Registration number if the viewed company is UK based. The unique Company Watch CW_ID identifier if the company is IE based. Used to Count "Unique UK and IE Company Records". See comment on Irish Company Data below for more details. |
|
Region |
The region of the company which has been viewed, either UK or IE. |
|
Company Name |
Company name for report viewed, if available. |
|
Company Status |
Live, Dissolved |
|
Record Count |
How many times a client has made an API request against this company, within the date range filter adjustable on the report. |
|
Earliest Request |
The earliest date this report was viewed, within the date range filter. |
|
Latest Request |
Latest Date this report was viewed, within the date range filter. |
Irish Company Data
Although API requests for Irish companies are recorded in our database, specific details such as company name, status, and registration number are currently unavailable. As a result, fields like company name will display "null" values in the report.
API Company Directors
Provides a record of successful API calls to the chargeable API action `director_get_data`.
|
Field Name |
Definition |
|
Director Number |
The unique Companies House Director Number. Used to count ‘unique records’. |
|
Current Postal Title |
Combined Title +Name +Surname of the Director. Note: The Director can be an individual person or a company |
|
Record Count |
How many times has our client viewed this Director, within the date range filter. |
|
Earliest Request |
The earliest date when this Director was viewed, within the date range filter. |
|
Latest Request |
The latest date when this Director was viewed, within the date range filter. |