API Connector Documentation

Print

Request Logging

Last Updated OnMarch 16, 2024
byAna
< Knowledge Base

Contents

Sheets Overview

To see an overview of which Sheets are running requests, click Account > Sheets from the footer of API Connector.

The Sheets tab contains a month-to-date request count for the currently logged-in user, broken down by Sheet name and type (standard vs ImportAPI). Note that this modal will only show counts for the logged-in user; even Team Plan Owners can see only their own sheets and request counts, not those of the members on their plan.

Monthly request counts reset on the 1st of the month (UTC time), and when a user's plan changes.

For more detailed information about the requests within each sheet, open the sheet and turn on request logging as shown below.

How to Enable Request Logging

To see a list and status of your requests, toggle on request logging from the Scheduling screen. Logging will store 1000 records.
scheduling-logs

Fields Logged

  • date and timestamp
  • request name
  • trigger type (scheduled or manual)
  • result (started, completed, or failed)
  • extra info (error messages returned by the request)
  • execution time in milliseconds
  • email address that executed the request

The log will include both manual and scheduled requests, and will be printed in sequential order into a sheet called AC_Log.

log-results

Note that the log records separate lines for "Request started" and "Request completed". This is to identify cases where requests begin as scheduled, but time out before they complete.

Execution Time

Execution time equals the time it took to run the request. This will equal the difference between the Request started log entry to the Request completed (or error) log entry.

What Doesn't Get Logged?

Can I Delete the AC_Log Sheet?

Sure, you can delete rows or even the entire sheet, it will just recreate itself if you still have the AC_Log option on. Once the log sheet reaches 1000 records, it will automatically delete earlier entries.


6 thoughts on “Request Logging”

  1. Hello, thanks for developing such a nice product.

    Can email notifications be sent when API requests fail?

    This is possible in Supermetrics and Power My Analytics. Thanks!

    Reply

    • Sorry, we don't currently have that feature. We'll be improving the account management and logging features later this year so will probably add in email notifications then.

      Reply

      • Thanks for the quick response, Ana. Is there a list of error messages that populate the 'AC_Log' that we can reference?

        We were looking at using Magic Cell Notifications GSheets add-on (https://www.notsomagicapps.com/magic-cell-notifications) to trigger an email based on certain 'AC_Log' cell values.

        For example, contains 'Request failed' would trigger a Magic Cell Notifications email notification.

        We did check the Error Messages KB article, but weren't confirm that these messages will be the same messages populated into the 'AC_Log' sheet cells:

        https://mixedanalytics.com/knowledge-base/api-connector-error-messages/

      • There are several sources of error messages, including Google Apps Script/Google Sheets, the API, and API Connector itself, which all get collected into this log sheet, so I don't actually have a full listing of all the possibilities. However, I believe these strings are present in nearly all the errors that might appear in D (the "results" column): Completed with errors, OAuth access not granted or expired, and Request failed.

        With that said, there's also the case where Google times out and therefore doesn't return any error message at all. In those cases there would just be a Request started message with no corresponding Request completed successfully line. I'm not sure if Magic Cell Notifications can allow for this kind of conditional logic.

  2. Thanks for the details. We are considering a helper column(s) in GSheets to serve as a conditional test. This helper column (along with some regex) could possibly be used with Magic Cell Notifications - or another GSheets add-on / custom script we may write.

    We will post the notifications solution we settle on here. We would be ecstatic if Mixed Analytics (MA) had a native feature for notifications. FYI We are consulting for a client on the free MA trial now and are moving towards a paid subscription.

    Reply

Leave a Comment

Jump To