Path parameters

• wound_id integer Required

  ID of the wound

Query parameters

• per_page integer

  Number of items per page.

• fields string(csv)

  Comma-separated list of fields to be returned in the response. Only 'id', 'uid', 'type', 'avg_depth', 'max_depth', 'max_width', 'max_length', 'perimeter', 'area', 'volume', 'date', 'granulation', 'slough', 'eschar', 'is_locked', and 'images' columns are allowed.

• filter object

  Filter criteria to narrow down the list of measurements. The filter parameter is an object with key-value pairs where the key is the field to filter by and the value is '{operator}{value}'. The operator is optional and defaults to '='. (e.g. '/measurements?wound_id=3089&filter[type]=group&filter[date]=>=2021-01-01')

  Hide filter attributes Show filter attributes object

  • id string

    Filter by ID with operators '>', '<', '>=', or '<='.

  • date string

    Filter by measurement date with operators '>', '<', '>=', or '<='.

  • type string

    Filter by measurement type.

  • avg_depth string

    Filter by average depth with operators '>', '<', '>=', or '<='.

  • max_depth string

    Filter by maximum depth with operators '>', '<', '>=', or '<='.

  • max_width string

    Filter by maximum width with operators '>', '<', '>=', or '<='.

  • max_length string

    Filter by maximum length with operators '>', '<', '>=', or '<='.

  • perimeter string

    Filter by perimeter with operators '>', '<', '>=', or '<='.

  • area string

    Filter by area with operators '>', '<', '>=', or '<='.

  • volume string

    Filter by volume with operators '>', '<', '>=', or '<='.

  • granulation string

    Filter by granulation percentage with operators '>', '<', '>=', or '<='.

  • slough string

    Filter by slough percentage with operators '>', '<', '>=', or '<='.

  • eschar string

    Filter by eschar percentage with operators '>', '<', '>=', or '<='.

  • is_locked boolean

    Filter by locked status (true or false).

  • created_at string

    Filter by creation date with operators '>', '<', '>=', or '<='.

  • updated_at string

    Filter by update date with operators '>', '<', '>=', or '<='.

• sort string

  Field to sort the results by. Only 'id' and 'created_at' columns are allowed, prefixed with a minus sign (-) for descending order and without for ascending order.

  Values are id, -id, created_at, or -created_at.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object]
    Hide data attributes Show data attributes object

    • id integer

      The unique identifier for the measurement.

    • uid string

      The unique identifier for the measurement.

    • type string

      The type of the measurement. Possible values are:

      • - 'group': Represents a group of measurements, where children are named as individuals (can be multiple or regular).
      • - 'multiple': Represents multiple measurements within the same image, allowing for inclusion & exclusion. Children are named as sub-measurements.
      • - 'regular': Represents a single measurement.

      Values are group, multiple, or regular.

    • avg_depth number

      The average depth of the wound in centimeters.

    • max_depth number

      The maximum depth of the wound in centimeters.

    • max_width number

      The maximum width of the wound in centimeters.

    • max_length number

      The maximum length of the wound in centimeters.

    • perimeter number

      The perimeter of the wound in centimeters.

    • area number

      The area of the wound in square centimeters.

    • volume number

      The volume of the wound in cubic centimeters.

    • date string(date)

      The date the measurement was taken.

    • granulation number

      The percentage of granulation tissue in the wound.

    • slough number

      The percentage of slough tissue in the wound.

    • eschar number

      The percentage of eschar tissue in the wound.

    • is_locked boolean

      Indicates whether the measurement is locked.

    • images object

      The images associated with the measurement. All images urls are signed URLs with a 10 minute expiration time.

      Hide images attributes Show images attributes object

      • thumbnail string

        The URL of the thumbnail image.

      • original string

        The URL of the original image.

      • outline string

        The URL of the outlined/traced image.

      • classification string

        The URL of the classification image.

    • children array[object]

      The child measurements associated with this measurement.

      • - For 'group' type measurements, children can be either 'regular' or 'multiple' measurements.
      • - For 'multiple' type measurements, children are exclusively 'regular' measurements.
      • - Maximum level of nesting is 2. For example, a 'group' measurement can have 'multiple' children, and each 'multiple' child can have 'regular' children.
    • created_at string(date-time)

      Date and time the site was created (UTC time)

  • metadata object
    Hide metadata attributes Show metadata attributes object

    • current_page integer
    • last_page integer
    • per_page integer
    • total integer
    • next_page_url string
    • prev_page_url string
• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • error string
  • message string
  • error_code number
• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • error string
  • message string
  • error_code number
• 403 application/json

  Forbidden

  Hide response attributes Show response attributes object

  • error string
  • message string
  • error_code number
• 422 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • error string
  • message string
  • error_code number