Troubleshoot API and report execution
Identify the failing layer and collect useful evidence without mistaking queue status for successful delivery.
Start with the narrowest failing step: reaching the server, authenticating, accessing a resource, saving configuration, executing a report, or delivering its output. That keeps a browser issue from being mistaken for a reporting failure.
Confirm the API address
IFBI installs the web application and API in IIS. The web application normally uses HTTPS on port 443; the API normally uses port 50255. Check that your client sends requests to the API URL, with the protocol, port and application path configured in IIS. A working web application page does not confirm that you are using the API address.
Check the request layer
| Symptom | First checks |
|---|---|
| Connection or TLS failure | API host and port (normally 50255), IIS application path, network route and certificate trust. |
| HTTP 400 | Required fields, IDs, model validation, names and operation-specific configuration. |
| HTTP 401 | Token validity, identity, relevant authorisation filter and required current-user context. |
| HTTP 403 | Installation licensing filter and the administrator’s licensing configuration. |
| HTTP 500 | The operation’s response and corresponding restricted server-side diagnostics. |
| HTML or a web sign-in page instead of the expected API response | Confirm that the request uses the API URL rather than the web application URL. |
| HTTP 200 with unexpected content | Bare versus wrapped response shape, IsError and endpoint-specific success rules. |
For Dataset Save, a non-GUID string can be a worksheet failure despite HTTP 200. See requests, responses and errors.
Check the reporting job layer
Check API availability confirms an API response. Its Gizmo-specific variant also reports the selected job’s deleted and enabled state. Neither proves end-to-end reporting health.
Get the current user’s queue returns a wrapped array with entry IDs, names, timestamps and status strings. Use the broader queue operation only with an appropriately authorised administrative identity. Do not assume a queue entry ID equals the Gizmo ID or the manual-run request ID.
Get Latest Error Log For Gizmo returns the latest recorded error. Compare its timestamps with the run under investigation: it may describe an older failure. The Investigate a queued or failed report job recipe in Recipes collects these observations.
Confirm the outcome before retrying
A queue entry disappearing or an error response containing no data does not establish success. Check IFBI execution evidence, the report’s configuration and source access, and the actual destination result. If data age is the issue, inspect dataset refresh history separately.
For support, retain the installed build, operation and method, timestamp with time zone, relevant resource IDs, HTTP status and a sanitised response summary. Provide detailed logs through an appropriate restricted support channel. Exclude bearer tokens, passwords and customer report data from ordinary messages.
Use reliable integration behaviour to make future failures easier to reconcile.
Updated about 3 hours ago