Skip to main content

API Endpoint Usage

A
Written by Arek
Updated today

The API Endpoint Usage page gives you a complete view of how your API integrations are performing. You can monitor the health of each endpoint, track implementation progress, and drill into individual API call logs to investigate errors.

What you'll need:

  • Access to Vehicle Management.

  • The API Endpoints tab.


🧭 How to access

Navigate to Vehicle Management and select the API Endpoints tab from the top navigation bar.


📋 Endpoint list

The page displays all your active API endpoints, sorted alphabetically. Each endpoint card shows:

  • Endpoint name — the name of the API endpoint.

  • API Health status — a colour-coded indicator of how the endpoint is currently performing:

    • 🟢 Healthy (green) — the endpoint is operating normally.

    • 🟡 Concerning (yellow) — some errors have been detected; worth monitoring.

    • 🔴 High error rate (red) — a significant share of recent calls are failing.

    • All calls failed (red) — every recent call to this endpoint has returned an error.

  • Implementation status — where the endpoint is in its rollout lifecycle:

    • Implemented (green) — the endpoint is fully live.

    • 🛠️ Under implementation (yellow) — the endpoint is still being set up.

    • 💤 Inactive > 30 days (grey) — no calls have been recorded for over 30 days.


🔎 Endpoint details

Click on any endpoint card to expand it. The expanded view includes:

  • Source — the integration identifier making the calls.

  • First Call — the date the very first API call was recorded.

  • Last Call — the date of the most recent API call.

  • Implemented At — the date the endpoint was marked as implemented (if applicable).

  • Webhook Status — the current status of the associated webhook subscription (if applicable).

  • Recent Activity table — a day-by-day breakdown showing the date, number of calls, and HTTP status code for each entry. Status codes are colour-coded: green for success (2xx) and red for errors (4xx/5xx).


🧾 Viewing API call details

From the Recent Activity table, click "View details" on any row (or click the row directly) to open the API Call History modal. This modal displays:

  • A summary header with the endpoint name, source, date, and total call count.

  • A scrollable log of individual API calls showing:

    • Row number

    • HTTP status code (colour-coded)

    • Request URL

    • Timestamp (in UTC)

  • For error responses (4xx/5xx), click the expand button to reveal the error message and request payload, which can help with debugging integration issues.

The log loads results in pages of 50 and automatically fetches more as you scroll.

💡Note: There is a delay in syncing detailed logs. Recent logs from today may not be visible yet. Request payloads are only logged for error responses (4xx/5xx status codes).

Need help?

  • Ask our AI Assistant: For real-time guidance, use the AI Assistant available directly within the Visibility platform UI.

  • Send Feedback: We value your input! If you have suggestions or feedback (good or bad), click the "?" icon in the lower left corner and select "Send feedback."

  • Support Portal: For technical issues that require a human touch, visit our Support Portal.

Did this answer your question?