Ctrl+K

Retrieve a list of metric values

Retrieve a list of metric values#

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description#

Returns a paginated list of metric Values

GET /prototype/platform/programs/{programId}/metrics/{metricId}/values

Required OAuth Scopes

file:read

Parameters#

Parameter

In

Type

Required

Description

X-Version

header

string

false

Version of the API (2022-01-01)

programId

path

string

true

The unique identifier of the program

metricId

path

string

true

The unique identifier of the metric

$maxpagesize

query

integer

false

The maximum number of results to retrieve

$next

query

string

false

Pagination cursor for next set of results.

$filter

query

string

false

The properties to filter the results by.

$orderBy

query

string

false

One or more comma-separated expressions to indicate the order in which to sort the results.

Filter Options#

Available logical operators: and, or

Name

Predicates Supported

id

eq, ne, in

notes

eq, ne, in, contains

reportingPeriod.end

eq, ne, in, gt, ge, lt, le

reportingPeriod.start

eq, ne, in, gt, ge, lt, le

reportingPeriod.year

eq, ne, in, gt, ge, lt, le

Sorting Options#

Name

Orders Supported

id

asc, desc

notes

asc, desc

reportingPeriod.end

asc, desc

reportingPeriod.start

asc, desc

reportingPeriod.year

asc, desc

Code Samples#

curl -X GET https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

http GET https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget --method=GET "https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/prototype/platform/programs/{programId}/metrics/{metricId}/values', headers = headers)

print(r.json())

Returns#

200 - OK#

Returns a JSON object with data and @nextLink properties. data contains a list of MetricValue objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

400 - Bad Request#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "coordinates": {
        "b38353ce-32bc-4ea7-852a-bf5e12b72d95": "Ames, IA"
      },
      "id": "5955107b-ed9e-43cb-a3a8-6fd1f73649c7",
      "reportingPeriod": {
        "end": 12,
        "start": 1,
        "year": 2024
      },
      "value": "512.8768743"
    }
  ]
}

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}