Skip to main content

Version Metadata

surveyIDSurvey Id (string)required

The unique identifier for this survey.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

versionIDVersion Id (string)required

The unique identifier for this survey version.

versionNumberVersion number (integer)required

The version number of this survey.

descriptionVersion description (string)required

A user-provided description of the survey version.

userIDUser Id (string)required

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

creationDatestring<date-time>required

The creation date of survey version expressed as an ISO 8601 value.

publishedPublished (boolean)required

When true, publish the new version.

wasPublishedWas published (boolean)required

Filter surveys by the publication status.

publishEvents object[]required
  • Array [
  • datestring<date-time>required

    The publication date of the survey expressed as an ISO 8601 value.

    userIDUser Id (string)required

    The unique identifier for a specific user.

    Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

    property name*any
  • ]
  • Version Metadata
    {
    "surveyID": "string",
    "versionID": "string",
    "versionNumber": 0,
    "description": "string",
    "userID": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "published": true,
    "wasPublished": true,
    "publishEvents": [
    {
    "date": "2024-07-29T15:51:28.071Z",
    "userID": "string"
    }
    ]
    }