eXPerience APIs Logs – Dynamic Yield Knowledge Base

These logs give you an in-depth overview of your server-side API calls, including events, pageviews, clicks, and choose variation calls. They enable you to verify that your API calls are correct and identify implementation issues. You can also use logs to troubleshoot unexpected behavior and find the root cause.

To access the API Logs, go to Settings › API Logs.

API Log Details

The timeline aggregates API calls into successful calls, calls with errors and calls with warnings. Hover over a bar for more details.

Below the timeline a table lists the recent API calls that occurred in the selected time range. Press Load More to see more API calls.

The following fields are available. To display more fields, click Columns at the top of the API Logs page.

Column	Details
Request Type	The type of API calls such as choose or pageview
Detail	Details about the request type, such as what type of event was called
Request ID	A unique identifier for each API call
Status	Displays the status code. 200 or 204 means everything was ok. Other codes are described next to the code.
User ID	The user ID provided in the API request
Session ID	The session ID provided in the API request
Timestamp	Displayed in seconds granularity
Duration	The time the request took in Dynamic Yield’s servers (excludes time spent in transit)

You can drill down on any API call to view more details by clicking anywhere in the row. This response is only available for logs that are under 32 KB.

Selecting a Time Range

You specify the time range by using the date picker:

You can also zoom in on a specific time range by clicking and dragging a box over the range you want.

A banner indicating the time range you set will appear. You can undo the zoom by clicking X.

Filtering the Results

Click the filters on the right to limit the results to only include items that match your selections. Each filter indicates how many entries apply for your time range.

If you select more than one filter in a section, items that match either selection are included (OR operator). If you select more than one filter in a different section, items must match both conditions (AND operator). For example, if you select Pageview and Choose in the Filter by Type section, and Error in the Filter by Status section, you would get results of items that are either Choose or Pageview that have errors.

You can also filter by using the search tool to specify a userID or a requestID.

Use Cases

Use Case	Resolution
During initial implementation I am making calls to the API to check that all attributes are received with the intended values (context type etc.) and no warnings.	Open the API Log and monitor the incoming calls, using the refresh button to view the latest calls.
During implementation, I noticed there are some warnings on API calls.	Select the row in the API log to see more details. You can see the full warnings including, for example - specific missing SKUs. You can also view the request body to see exactly how you passed the data to the API.
In production (or any other high volume environment), I suspect there are some problematic API calls, but I am not sure exactly when they are happening.	You can zoom in on a specific time range that has a high volume of errors or warnings. You can also use filters to only view API calls that have the errors or warnings you are looking for.
In a high-volume platform, I want to see what one user is doing.	Enter their user ID in the search bar to filter the log.
Someone wants to tell me about an issue by sharing a bookmark or reference to the issue.	This can be accomplished by entering the User ID in the search bar. If you don’t have the user ID, enter the request ID and use that to look for the user ID in the filtered results.
I know there are currently errors/warnings and I want to know “when it broke”, so I can (a) understand the scope of the problem, (b) correlate it with any changes I made	Zoom in to a suspected time range, and then use filters to narrow down the results to a specific error or warning type.
I applied a fix to some error/warning and want to see there are no more requests with this type of issue	Use the time-range control and/or filters to see if/when a problem stopped and whether the issue was fully or partially resolved.