Skip to content
SurveyRock Support

Get change classification

GET
/surveys/{id}/publish/changes
curl --request GET \
  --url https://app.surveyrock.com/api/v1/surveys/example/publish/changes \
  --header 'Authorization: Bearer <token>'

Returns classification of changes between draft and live versions, categorizing each change as structural or cosmetic.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Survey ID

Responses

Section titled “Responses”

200

Section titled “200”

Change classification result

Media typeapplication/json
object
success
boolean
data
object
hasStructuralChanges
boolean
hasCosmeticChanges
boolean
hasNewQuestions
boolean
structuralCount
integer
cosmeticCount
integer
deletedCount
integer
addedCount
integer
identicalCount
integer
warningLevel
string
Allowed values: none low high
changes
object
structural
Array<object>
object
cosmetic
Array<object>
object
identical
Array<object>
object
deleted
Array<object>
object
added
Array<object>
object
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": true,
  "data": {
    "warningLevel": "none"
  },
  "meta": {
    "version": "3.0"
  }
}

404

Section titled “404”

Survey not found

Media typeapplication/json

Standard error response format

object
success
boolean
error
object
code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string
message

Human-readable error message

string
suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string
retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean
details

Additional, code-specific error details

object
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}