API reference › Providers › Provider portal

Get service provider impact statistics

GET /v1/dashboard/provider-portal/service-impact

Scope
providers:read
Roles
service-provider

Retrieve service impact statistics including consumers supported, clients supported, and locations worked

Parameters

Query parameters

NameTypeDescription
startDatestring (date)

Start date for filtering (YYYY-MM-DD format)

Example 2025-01-01.

endDatestring (date)

End date for filtering (YYYY-MM-DD format)

Example 2025-12-31.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl "https://api.fetchfido.ai/v1/dashboard/provider-portal/service-impact" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Service impact statistics retrieved successfully

Service impact statistics retrieved successfully

JSON
{
  "success": true,
  "message": "Service impact statistics retrieved successfully",
  "data": {
    "cards": [
      {
        "key": "consumers_supported",
        "title": "Consumers Supported",
        "total": 24,
        "breakdown": [
          {
            "label": "On-Site",
            "value": 18,
            "type": "onsite"
          }
        ]
      }
    ]
  }
}
Response fields (11)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service impact statistics retrieved successfully.

dataobject
data.cardsarray of object
data.cards[].keystring

Example consumers_supported.

data.cards[].titlestring

Example Consumers Supported.

data.cards[].totalinteger

Example 24.

data.cards[].breakdownarray of object
data.cards[].breakdown[].labelstring

Example On-Site.

data.cards[].breakdown[].valueinteger

Example 18.

data.cards[].breakdown[].typestring

Example onsite.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'providers:read' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'providers:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.