API Connector Report

API connectors push data into Mobio in real time — which means an integration issue can generate a flood of failed records before anyone notices. The API Connector report gives you session-by-session visibility into every push, so you can catch failures as they happen instead of after the fact.

1. Overview

  • Definition: Tracks the process of receiving and processing data from the API source, by sync session.
  • Benefits/Value: Quickly check running sessions, the success/failure rate, and catch failed sessions early.
  • Target users: System Admin, Data Engineer.

2. Terminology & Specifications

  • Sync session: A data processing lifecycle created when a connection is enabled or run on a schedule.
  • Successful/Failed/Pending records: Metrics reflecting data processing results within the filter period.
  • Sync status: Awaiting processing, Syncing, Failed Sync, Sync Stopped, Sync Complete.
  • Session display mode: Table View and Pipeline View.

3. Prerequisites

  • Previous article: Complete an API connector setup and data sync configuration for at least 1 entity.
  • Permissions: Your Mobio account must have the INTEGRATION RBAC permission. See the RBAC permissions guide.
  • Access Path: Go to Settings → Data Integration → Data Flow/Data Source → select the API connector → Report.
  • Input data: At least one sync session has run in the API connector.

4. Implementation steps

4.1. Set up report filters

  • Select a sync time range: today, yesterday, 7 days ago, 30 days ago, this month, last month, 90 days ago, or custom.
  • Select a sync status to focus on the sessions you need to monitor.

4.2. Track summary metrics

  • Check the total records.
  • Check the total successful, failed, and pending records.
  • Check the total sessions by status.

4.3. Track performance by session

  • Open the Table View to review the session list and detailed metric columns.
  • Open Pipeline View to visually track a session’s ingest and processing flow.
  • Check sessions with a large gap between successful records and processed records first.

4.4. Check sync session details

  • Open a session from the list to check its details.
  • Compare records by day and by sync status within the session.

5. Operational Rules & Use Cases

Operational Rules

  • Monitor Log & notifications: From the API Connector’s report screen, view detailed Monitor Logs for every API call. You can also set up notifications for sync events, triggered when a data push succeeds or fails.

Use Cases

  • When failures increase, filter by Failed Sync first to isolate the most recent failed session.
  • When a session runs for multiple days, check the day-by-day breakdown before concluding there’s a data backlog.
  • Always compare within the same time filter and the same connector to avoid discrepancies.

6. Frequently Asked Questions (FAQ)

  • Q: Should I use Table View or Pipeline View? 
    • A: Use Table View to quickly scan the full session; use Pipeline View to watch the processing flow in real time.
  • Q: Why are there pending records even though the session is running? 
    • A: The session may still be receiving data. Keep tracking its progress — if the pending count stays high, move to log investigation.

7. Next Steps

Monitor & Troubleshoot Sync Issues with Monitor Log

image-zoom
© MOBIO 2022 v1.3 Powered by MOBIO
Back to Top