Get referral set statistics

GET 
/api/v2/referral-sets/stats

Get the total taker volume, and each referee's taker volume and, reward and discount factors for a referral set at the latest or a specific epoch. You can also optionally filter for a specific referee's statistics.

Request

Query Parameters

referralSetId string

Restrict referral set statistics to those for the given referral set.

atEpoch uint64

Epoch to get referral set statistics for. If not set, the last complete epoch is used.

referee string

Restrict referral set statistics to those for the given referee.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

stats object

Referral set statistics for the epoch.

edges object[]

Page of volume discount statistics data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Referral set stats data.

atEpoch uint64

Epoch at which the set's statistics were updated.

discountFactor string

Discount factor applied to the party.

epochNotionalTakerVolume string

Current referee notional taker volume.

partyId string

Party ID.

referralSetRunningNotionalTakerVolume string

Running volume for the set based on the window length of the current referral program.

referrerTakerVolume Referrer's taker volume

rewardFactor string

Reward factor applied to the party.

rewardsFactorMultiplier string

Proportion of the referee's taker fees to be rewarded to the referrer.

rewardsMultiplier string

Multiplier applied to the referral reward factor when calculating referral rewards due to the referrer.

wasEligible boolean

Indicates if the referral set was eligible to be part of the referral program.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "stats": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "atEpoch": "string",
          "discountFactor": "string",
          "epochNotionalTakerVolume": "string",
          "partyId": "string",
          "referralSetRunningNotionalTakerVolume": "string",
          "referrerTakerVolume": "string",
          "rewardFactor": "string",
          "rewardsFactorMultiplier": "string",
          "rewardsMultiplier": "string",
          "wasEligible": true
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...