Observability / Org Limits

Get org limits summary for all monitored environments in a repository

get

Returns all monitoring-enabled environments with their worst-limit status. Environments are discovered from existing metrics in VictoriaMetrics.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringOptional

Repository identifier in format owner/repo. When omitted, returns a tenant-wide summary across every monitored environment.

Example: flxbl-io/sf-core

Responses

200

Summary retrieved successfully

application/json

orgUsernamestringRequired

Salesforce username that uniquely identifies the org being observed

Example: [email protected]

statusstring · enumRequired

Overall status

Example: warningPossible values:

lastPolledAtstringRequired

Last polled timestamp

Example: 2026-02-14T10:30:00Z

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/observability/limits/summary

HTTPcURLJavaScriptPython

GET /sfp/api/observability/limits/summary HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "orgUsername": "[email protected]",
    "environmentLabels": [
      {
        "name": "prod",
        "repositoryIdentifier": "flxbl-io/sf-core"
      }
    ],
    "status": "warning",
    "lastPolledAt": "2026-02-14T10:30:00Z",
    "worstLimit": {
      "name": "DailyApiRequests",
      "usagePct": 85.5,
      "alertLevel": "warning"
    }
  }
]

Get org limits dashboard for a specific environment

get

Returns time-series chart data, current snapshot table, and alerts for a specific environment. Results are cached based on the time range type.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

environmentNamestringRequired

Environment name

Example: prod

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

rangestring · enumRequired

Time range for metrics

Example: todayPossible values:

forceRefreshbooleanOptional

Force refresh - bypass cache and fetch fresh data

Default: falseExample: false

Responses

200

Dashboard data retrieved successfully

application/json

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/observability/limits/dashboard

HTTPcURLJavaScriptPython

GET /sfp/api/observability/limits/dashboard?environmentName=prod&repositoryIdentifier=flxbl-io%2Fsf-core&range=today HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "range": "today",
    "rangeLabel": "Today",
    "start": "2026-02-14T00:00:00Z",
    "end": "2026-02-14T12:30:00Z",
    "environmentName": "prod",
    "repositoryIdentifier": "flxbl-io/sf-core",
    "generatedAt": "2026-02-14T12:30:00Z",
    "cached": false,
    "queryDurationMs": 125
  },
  "timeSeries": [
    {
      "limitName": "DailyApiRequests",
      "dataPoints": [
        {
          "timestamp": "2026-02-14T10:00:00Z",
          "usagePct": 31.85
        }
      ]
    }
  ],
  "snapshot": [
    {
      "name": "DailyApiRequests",
      "max": 15000,
      "used": 4777,
      "remaining": 10223,
      "usagePct": 31.85,
      "alertLevel": "ok"
    }
  ],
  "alerts": [
    {
      "name": "DailyApiRequests",
      "max": 15000,
      "used": 4777,
      "remaining": 10223,
      "usagePct": 31.85,
      "alertLevel": "ok"
    }
  ]
}

Get current org limits snapshot for a specific environment

get

Returns lightweight current values only (no time-series data).

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

environmentNamestringRequired

Environment name

Example: prod

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

Responses

200

Snapshot retrieved successfully

application/json

namestringRequired

Salesforce limit name

Example: DailyApiRequests

maxnumberRequired

Maximum allowed value

Example: 15000

usednumberRequired

Currently used value

Example: 4777

remainingnumberRequired

Remaining value

Example: 10223

usagePctnumberRequired

Usage percentage (0-100)

Example: 31.85

alertLevelstring · enumRequired

Alert level based on usage

Example: okPossible values:

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/observability/limits/snapshot

HTTPcURLJavaScriptPython

GET /sfp/api/observability/limits/snapshot?environmentName=prod&repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "DailyApiRequests",
    "max": 15000,
    "used": 4777,
    "remaining": 10223,
    "usagePct": 31.85,
    "alertLevel": "ok"
  }
]