/
Update profile dashboard

Update profile dashboard
Experimental

Request

Updates the profile dashboard configuration.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Profile dashboard resource.

dateRangestring

Date range of the dashboard, in ISO-8601 interval format, extended with NOW and relative anchor tokens for relative dates. This range applies to every tile that does not define its own dateRange. Supported formats:

  • Start and end: 2024-01-01T00:00:00Z/2024-02-01T00:00:00Z.
  • Start and duration 2024-01-01T00:00:00Z/P1M.
  • Duration and end: P1M/2024-02-01T00:00:00Z.
  • Now and duration: NOW-P1M/NOW. This format represents the last month.
  • Month before last month: NOW-P2M/NOW-P1M.
  • Anchor tokens: NOW_D, NOW_W, NOW_M and NOW_Y resolve to the start of the current day, week, month or year when used as the start of the range, and to the end of that period when used as the end of the range. Combine an anchor with a signed duration, for example NOW_M-P1M, to shift the period after snapping to the boundary.
  • Today: NOW_D/NOW_D.
  • Yesterday: NOW_D-P1D/NOW_D-P1D.
  • This week: NOW_W/NOW_D.
  • Last week: NOW_W-P1W/NOW_W-P1W.
  • Last month: NOW_M-P1M/NOW_M-P1M.
Default:"NOW-P1M/NOW"
tabsArray of objects, <= 10 items(DashboardTab)required

List of dashboard tabs.

curl -i -X PUT \
  https://www.rebilly.com/_mock/catalog/all/profile/dashboard \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "dateRange": "NOW-P1M/NOW",
    "tabs": [
      {
        "title": "KYC",
        "tiles": [
          {
            "metric": "string",
            "title": "string",
            "description": "string",
            "dateRange": "string",
            "columnsWidth": 1
          }
        ],
        "preset": "Payments"
      }
    ]
  }'

Responses

Profile dashboard updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
dateRangestring

Date range of the dashboard, in ISO-8601 interval format, extended with NOW and relative anchor tokens for relative dates. This range applies to every tile that does not define its own dateRange. Supported formats:

  • Start and end: 2024-01-01T00:00:00Z/2024-02-01T00:00:00Z.
  • Start and duration 2024-01-01T00:00:00Z/P1M.
  • Duration and end: P1M/2024-02-01T00:00:00Z.
  • Now and duration: NOW-P1M/NOW. This format represents the last month.
  • Month before last month: NOW-P2M/NOW-P1M.
  • Anchor tokens: NOW_D, NOW_W, NOW_M and NOW_Y resolve to the start of the current day, week, month or year when used as the start of the range, and to the end of that period when used as the end of the range. Combine an anchor with a signed duration, for example NOW_M-P1M, to shift the period after snapping to the boundary.
  • Today: NOW_D/NOW_D.
  • Yesterday: NOW_D-P1D/NOW_D-P1D.
  • This week: NOW_W/NOW_D.
  • Last week: NOW_W-P1W/NOW_W-P1W.
  • Last month: NOW_M-P1M/NOW_M-P1M.
Default:"NOW-P1M/NOW"
periodStartstring, (date-time)read-only

Date and time when the dashboard period starts. The value is resolved from dateRange.

periodEndstring, (date-time)read-only

Date and time when the dashboard period ends. The value is resolved from dateRange.

tabsArray of objects, <= 10 items(DashboardTab)required

List of dashboard tabs.

Response
{
  "dateRange": "NOW-P1M/NOW",
  "periodStart": "2019-08-24T14:15:22Z",
  "periodEnd": "2019-08-24T14:15:22Z",
  "tabs": [
    { … }
  ]
}