PIpipeshub-ai
Connector Instances

Get connector statistics

Changed on

Retrieve record counts of a connector instance, in total and per record type, broken down by indexing status. The ID of a knowledge base is accepted too (a knowledge base is stored as a connector instance of type <code>KB</code>); its stats report <code>origin: COLLECTION</code>.<br><br> <b>Who can read them:</b> the creator of the instance and, for a team instance, org admins. Stats use the same read gate as <code>GET /connectors/{connectorId}</code>: anyone else, including an admin reading another user's personal instance, gets <code>404</code> ("This connector was removed, or you no longer have access. ..."), so the instance's existence is not confirmed.

An OAuth token holding kb:read instead of connector:read passes the scope check too.

get/connectors/{connectorId}/stats

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}/stats
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:read

Path parameters

connectorIdstring required

Connector instance ID (_key of the instance) or knowledge base ID. Unlike the other instance routes, the ID is not checked against a pattern: an ID no instance has is answered 404.

Response

Connector statistics

successboolean required

Example response

{
  "data": {
    "origin": "CONNECTOR",
    "byRecordType": [
      {
        "recordType": "FILE"
      }
    ]
  }
}

Changes

  • dbb5e203b445Revision changes
    • warning

      added the new COLLECTION enum value to the / response property for the response status

    • warning

      added the new CONNECTOR enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • fc76aa045994Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status