Metrics
/metrics/owner-revenue
Owner revenue metric (locked vs unlocked) by month
Required scope: metrics:read
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
ownerId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidstartDate?string
Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
Format
vrp-date-boundaryendDate?string
Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.
Format
vrp-date-boundarydateRange?string
Date range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD. Single values expand to the full year, month, or day.
Format
vrp-date-rangeisDateRangeEndInclusive?boolean
Whether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).
Default
truecurrency?string
Currency in ISO 4217 format, will be converted to lowercase
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/metrics/owner-revenue?ownerId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"date": "string",
"lockedRevenue": 0,
"unlockedRevenue": 0
}
]
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}