On this page

    1. Home
    2. API
    3. API Reference
    4. Stats
    5. Provider Last 90

    Provider Last 90

    This document describes the provider-last-90 endpoint, which is used to retrieve detailed statistics for a single provider within the caller's network over the last 90 days. This endpoint provides complete visibility over a provider's usage.


    POST /stats/provider-last-90

    Get detailed stats on a single provider in the caller network. This is meant to give the user complete visibility over usage.

    Authorizations

    This endpoint requires a BringYour JWT.

    Headers:

    {
      "Host": "api.bringyour.com",
      "Authorization": "Bearer YOUR_JWT_TOKEN",
      "Content-Type": "application/json",
      "Accept": "*/*"
    }

    Body:

    The request body should be a JSON object containing the client_id of the provider for which to retrieve statistics.

    {
      "client_id": "string"
    }
    FieldTypeDescription
    client_idstringThe unique identifier (UDID) of the provider.

    Response

    200 Success

    Status: 200 OK

    Content-Type: application/json

    A successful response returns detailed statistics for the specified provider over the last 90 days.

    {
      "lookback": 1,
      "created_time": "text",
      "uptime": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "transfer_data": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "payout": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "search_interest": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "contracts": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "clients": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "client_details": [
        {
          "client_id": "text",
          "transfer_data": {
            "ANY_ADDITIONAL_PROPERTY": 1
          }
        }
      ]
    }
    FieldTypeDescription
    lookbacknumberThe number of days the statistics cover (e.g., 90).
    created_timestringTimestamp indicating when the statistics were generated or last updated.
    uptimeobjectKey-value pairs representing uptime statistics (e.g., daily uptime averages).
    transfer_dataobjectKey-value pairs representing transfer data (e.g., daily transfer volumes).
    payoutobjectKey-value pairs representing payout statistics (e.g., daily payout amounts).
    search_interestobjectKey-value pairs representing search interest data.
    contractsobjectKey-value pairs representing contract statistics.
    clientsobjectKey-value pairs representing client statistics.
    client_detailsarrayAn array of client detail objects connected to this provider.
        client_idstringThe unique identifier for the client.
        transfer_dataobjectKey-value pairs representing transfer data specific to this client.

    Example

    HTTP Request

    POST /stats/provider-last-90 HTTP/1.1
    Host: api.bringyour.com
    Authorization: Bearer YOUR_JWT_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 20
     
    {
      "client_id": "text"
    }

    Successful HTTP Response

    {
      "lookback": 1,
      "created_time": "text",
      "uptime": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "transfer_data": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "payout": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "search_interest": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "contracts": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "clients": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "client_details": [
        {
          "client_id": "text",
          "transfer_data": {
            "ANY_ADDITIONAL_PROPERTY": 1
          }
        }
      ]
    }


    Powered by Sudoc v2.5.0
    Hide table of contents