Logs
Use logs to view detailed information on API and webhook transactions.
By default, log data is organized into four segments:
- API crashes: Contains logs on API crashes (
status
greater or equal to500
). - API errors: Contains logs on API errors (
status
is between409
,499
). - API logs: Contains logs unfiltered API logs.
- Tax logs: Contains unfiltered tax logs.
- Webhook logs: Contains unfiltered webhook logs.
To add or manage segments, or to apply or edit filters on a segment, see Segments.
View logs information
- In the left navigation bar, press Data tables, press Logs, then click: API crashes, API errors, API logs, or Webhook logs.
- Press a log item in the table. Detailed log information is displayed.
Filter logs
This section describes how to filter logs based on related IDs.
Filter webhook logs by related entity IDs
Use this process to find webhook logs related to particular customers, transactions, or invoices.
- In the left navigation bar, press Data tables, press Logs, then press Webhook logs.
- In the top right of the table, press Filters .
- In the Filter dropdown, select Entity ID
- In the Operation dropdown, select a condition.
- In the Value field, enter ID values.
Optionally, to compare against lists of data values, create a value list and use it in this filter. For more information, see Value lists. - In the dropdown or text field, enter or select values.
- Press Apply filter.
- Optionally, to save the filtered data to the active segment, press Save.
- Optionally, to create a new segment based on the filtered data, press Save segment as, enter a name for the new segment, and then press Save.
Filter API logs by related IDs
Use this process to find API logs related to particular customers, transactions, or invoices.
- In the left navigation bar, press Data tables, press Logs, then select API crashes, API Errors, or API logs.
- In the top right of the table, press Filters .
- In the Filter dropdown, select: Related IDs Customer ID, Related IDs token ID, or Related IDs transaction ID.
- In the Operation dropdown, select a condition.
- In the Values field, enter ID values.
Optionally, to compare against lists of data values, create a value list and use it in this filter. For more information, see Value lists. - In the dropdown or text field, enter or select values.
- Press Apply filter.
- Optionally, to save the filtered data to the active segment, press Save.
- Optionally, to create a new segment based on the filtered data, press Save segment as, enter a name for the new segment, and then press Save.
Filter tax logs by related entity IDs
Use this process to find tax logs related to particular invoices, or credit memos.
- In the left navigation bar, press Data tables, press Logs, then press Tax logs.
- In the top right of the table, press Filters .
- In the Filter dropdown, select Entity ID
- In the Operation dropdown, select a condition.
- In the Value field, enter ID values.
Optionally, to compare against lists of data values, create a value list and use it in this filter. For more information, see Value lists. - In the dropdown or text field, enter or select values.
- Press Apply filter.
- Optionally, to save the filtered data to the active segment, press Save.
- Optionally, to create a new segment based on the filtered data, press Save segment as, enter a name for the new segment, and then press Save.