Heads Up: This article is for Watershed's free product Watershed Essentials. If you're a paid client, please visit our main help section.
Expertise: This article is best executed with technical or xAPI knowledge.
How do I use the error log in my Watershed Essentials account?
The error log is useful for viewing and tracking xAPI statements that Watershed Essentials has rejected as invalid. Normally, this log only records errors relating to xAPI statements. As a result, errors relating to invalid authentication credentials, incorrect endpoint URLs, or requests that don’t contain statements may not be recorded.
Accessing the Error Log
To access the statement viewer, click the Data tab at the top of your screen. After being redirected to a new page, select “Error Log” on the left side of the screen.
Understanding Error Messages
Errors are recorded when Watershed receives an interaction statement (i.e., xAPI statement) batch that contains an invalid statement. These error messages explain the reason why a statement was rejected so you or a developer can fix the problem.
In Watershed Essentials, errors are listed chronologically with the most recent one appearing at the top of the list. You also will see the date and time that each error was recorded and the error message that was returned. Clicking on an error will expand the entry and display the following data:
Request: The type of request that was made and the endpoint it was sent to.
Sender: The name and account of the Activity Provider credentials used to make the request. We recommend you create separate Activity Provider credentials for testing than you use for any real data.
Statements: The complete JSON of the statement(s) included in the request.
Searching and Filtering Data
Normally, data sources shouldn’t generate errors on an ongoing basis, so you can simply look at the most recent error messages to find the information you need. If you need to find a specific error or a past date and time, try the text and timestamp search options at the top of the screen.
Use the search box to find a particular word or term. This will filter and highlight errors that contain the term in any of the fields, including the error message and statement itself.
To filter by a date range, use the timestamp search fields and select dates and times using the date picker.
Once you or a developer has resolved an error, you can archive it so only outstanding issues appear. Simply click “Archive” to the right of the error message to move it to the Archived Errors tab. You also can select “Archive all errors” (at the top of the screen) to send all errors to the archive list. Archived errors can be viewed and unarchived at any time from the Archived Errors tab.