1873 строки
59 KiB
JSON
1873 строки
59 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"x-ms-deployment-version": "1.0.0",
|
||
"version": "1.0",
|
||
"title": "SurveyMonkey",
|
||
"description": "SurveyMonkey is the world's leading provider of web-based survey solutions. These solutions are used by companies, organizations, and individuals to gather the insights they need to make more informed decisions.",
|
||
"x-ms-api-annotation": {
|
||
"status": "Preview"
|
||
},
|
||
"contact": {
|
||
"name": "Microsoft",
|
||
"url": "https://support.microsoft.com"
|
||
}
|
||
},
|
||
"host": "api.surveymonkey.net",
|
||
"basePath": "/v3",
|
||
"schemes": [
|
||
"https"
|
||
],
|
||
"consumes": [],
|
||
"produces": [],
|
||
"paths": {
|
||
"/surveys": {
|
||
"get": {
|
||
"summary": "List surveys",
|
||
"description": "List the surveys in the account.",
|
||
"operationId": "GetSurveys",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Surveys"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/collectors/{collectorId}": {
|
||
"get": {
|
||
"summary": "Get a collector",
|
||
"description": "Get details of a specific collector.",
|
||
"operationId": "GetSurveyCollector",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "collectorId",
|
||
"in": "path",
|
||
"required": true,
|
||
"x-ms-summary": "Collector ID",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyCollector"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/collectors/{collectorId}/messages": {
|
||
"get": {
|
||
"summary": "Get messages",
|
||
"description": "Get survey messages for a given survey collector.",
|
||
"operationId": "GetSurveyMessages",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "collectorId",
|
||
"in": "path",
|
||
"required": true,
|
||
"x-ms-summary": "Collector ID",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyMessages"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/surveys/{surveyId}/collectors": {
|
||
"get": {
|
||
"summary": "List collectors",
|
||
"description": "Get a list of collectors for a given survey.",
|
||
"operationId": "GetSurveyCollectors",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"description": "Select a survey",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "title"
|
||
},
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyCollectors"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/surveys/{surveyId}": {
|
||
"get": {
|
||
"summary": "Get a survey",
|
||
"description": "Get details of a specific survey.",
|
||
"operationId": "GetSurvey",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"description": "The id of the survey",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Survey"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"/collectors/{collectorId}/messages/{messageId}/send": {
|
||
"post": {
|
||
"summary": "Schedule an existing invite message",
|
||
"description": "Send or schedule to send an existing message to all message recipients.",
|
||
"operationId": "SendMessage",
|
||
"consumes": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml",
|
||
"application/x-www-form-urlencoded"
|
||
],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "query",
|
||
"description": "Select a survey",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "title"
|
||
},
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "collectorId",
|
||
"in": "path",
|
||
"description": "Select a collector",
|
||
"required": true,
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyCollectors",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "name",
|
||
"parameters": {
|
||
"surveyId": {
|
||
"parameter": "surveyId"
|
||
}
|
||
}
|
||
},
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "messageId",
|
||
"in": "path",
|
||
"description": "Select a message",
|
||
"required": true,
|
||
"x-ms-summary": "Message ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyMessages",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "type",
|
||
"parameters": {
|
||
"collectorId": {
|
||
"parameter": "collectorId"
|
||
}
|
||
}
|
||
},
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"scheduled_date": {
|
||
"format": "date-time",
|
||
"description": "Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:00.000Z)",
|
||
"type": "string",
|
||
"x-ms-summary": "Scheduled date",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
},
|
||
"x-ms-summary": "Scheduled date"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyMessageResponse"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "important",
|
||
"x-ms-no-generic-test": true
|
||
}
|
||
},
|
||
"/trigger1/surveys": {
|
||
"get": {
|
||
"summary": "When a new survey is created",
|
||
"description": "Triggers a new flow when a survey is created.",
|
||
"operationId": "OnSurveyCreated",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/NewSurveys"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "important",
|
||
"x-ms-trigger": "batch",
|
||
"x-ms-trigger-hint": "To see it work now, create a survey.",
|
||
"x-ms-trigger-metadata": {
|
||
"mode": "polling",
|
||
"kind": "query"
|
||
}
|
||
}
|
||
},
|
||
"/trigger2/surveys/{surveyId}/collectors": {
|
||
"get": {
|
||
"summary": "When a new collector is created",
|
||
"description": "Triggers a new flow when a collector is created.",
|
||
"operationId": "OnSurveyCollectorCreated",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"description": "Select a survey",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "title"
|
||
},
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/NewCollectors"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "advanced",
|
||
"x-ms-trigger": "batch",
|
||
"x-ms-trigger-hint": "To see it work now, create a survey collector.",
|
||
"x-ms-trigger-metadata": {
|
||
"mode": "polling",
|
||
"kind": "query"
|
||
}
|
||
}
|
||
},
|
||
"/trigger3/collectors/{collectorId}/responses/bulk": {
|
||
"get": {
|
||
"summary": "When a new collector response is added",
|
||
"description": "Triggers a new flow when a response is added (paid account only).",
|
||
"operationId": "OnNewResponseAddedCollector",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "query",
|
||
"description": "Select a survey",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "title"
|
||
},
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "collectorId",
|
||
"in": "path",
|
||
"description": "Select a collector",
|
||
"required": true,
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyCollectors",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "name",
|
||
"parameters": {
|
||
"surveyId": {
|
||
"parameter": "surveyId"
|
||
}
|
||
}
|
||
},
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyResponses"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "advanced",
|
||
"x-ms-trigger": "batch",
|
||
"x-ms-trigger-hint": "To see it work now, respond to a survey.",
|
||
"x-ms-trigger-metadata": {
|
||
"mode": "polling",
|
||
"kind": "query"
|
||
}
|
||
}
|
||
},
|
||
"/trigger4/surveys/{surveyId}/responses/bulk": {
|
||
"get": {
|
||
"summary": "When a new survey response is added",
|
||
"description": "Triggers a new flow when a survey response is added (paid account only).",
|
||
"operationId": "OnNewResponseAddedSurvey",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"description": "Select a survey",
|
||
"required": true,
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-collection": "data",
|
||
"value-path": "id",
|
||
"value-title": "title"
|
||
},
|
||
"type": "string"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyResponses"
|
||
}
|
||
}
|
||
},
|
||
"deprecated": false,
|
||
"x-ms-visibility": "important",
|
||
"x-ms-trigger": "batch",
|
||
"x-ms-trigger-hint": "To see it work now, respond to a survey.",
|
||
"x-ms-trigger-metadata": {
|
||
"mode": "polling",
|
||
"kind": "query"
|
||
}
|
||
}
|
||
},
|
||
"/surveys/{surveyId}/pages": {
|
||
"get": {
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"title": {
|
||
"type": "string",
|
||
"description": "title"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"description": "description"
|
||
},
|
||
"position": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "position"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"description": "id"
|
||
},
|
||
"href": {
|
||
"type": "string",
|
||
"description": "href"
|
||
}
|
||
}
|
||
},
|
||
"description": "data"
|
||
},
|
||
"per_page": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "per_page"
|
||
},
|
||
"page": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "page"
|
||
},
|
||
"total": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "total"
|
||
},
|
||
"links": {
|
||
"type": "object",
|
||
"properties": {
|
||
"self": {
|
||
"type": "string",
|
||
"description": "self"
|
||
}
|
||
},
|
||
"description": "links"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"operationId": "GetSurveyPages",
|
||
"description": "List the pages for a survey",
|
||
"summary": "List survey pages",
|
||
"x-ms-visibility": "internal",
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "title"
|
||
}
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/trigger5/surveys/{surveyId}/responses/bulk": {
|
||
"get": {
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/SurveyResponses"
|
||
}
|
||
}
|
||
},
|
||
"summary": "When a new survey response to a question is added",
|
||
"description": "Triggers a new flow when a response to a question is added (paid account only).",
|
||
"operationId": "OnNewResponseToQuestionAdded",
|
||
"consumes": [],
|
||
"produces": [
|
||
"application/json",
|
||
"text/json",
|
||
"application/xml",
|
||
"text/xml"
|
||
],
|
||
"x-ms-trigger": "batch",
|
||
"x-ms-trigger-hint": "To see it work now, respond to a survey question.",
|
||
"x-ms-trigger-metadata": {
|
||
"mode": "polling",
|
||
"kind": "query"
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "title"
|
||
},
|
||
"x-ms-summary": "Survey ID",
|
||
"description": "Select the survey"
|
||
},
|
||
{
|
||
"name": "page_ids",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyPages",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "position",
|
||
"parameters": {
|
||
"surveyId": {
|
||
"parameter": "surveyId"
|
||
}
|
||
}
|
||
},
|
||
"description": "Select the page",
|
||
"x-ms-summary": "Page ID"
|
||
},
|
||
{
|
||
"name": "question_ids",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyPageQuestions",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "heading",
|
||
"parameters": {
|
||
"surveyId": {
|
||
"parameter": "surveyId"
|
||
},
|
||
"pageId": {
|
||
"parameter": "page_ids"
|
||
}
|
||
}
|
||
},
|
||
"description": "Select the question",
|
||
"x-ms-summary": "Question ID"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/surveys/{surveyId}/pages/{pageId}/questions": {
|
||
"get": {
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"heading": {
|
||
"type": "string",
|
||
"description": "heading"
|
||
},
|
||
"position": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "position"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"description": "id"
|
||
},
|
||
"href": {
|
||
"type": "string",
|
||
"description": "href"
|
||
}
|
||
}
|
||
},
|
||
"description": "data"
|
||
},
|
||
"per_page": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "per_page"
|
||
},
|
||
"page": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "page"
|
||
},
|
||
"total": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "total"
|
||
},
|
||
"links": {
|
||
"type": "object",
|
||
"properties": {
|
||
"self": {
|
||
"type": "string",
|
||
"description": "self"
|
||
}
|
||
},
|
||
"description": "links"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"summary": "List survey page questions",
|
||
"description": "List the questions on a given survey page",
|
||
"operationId": "GetSurveyPageQuestions",
|
||
"x-ms-visibility": "internal",
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveys",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "title"
|
||
}
|
||
},
|
||
{
|
||
"name": "pageId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "GetSurveyPages",
|
||
"value-path": "id",
|
||
"value-collection": "data",
|
||
"value-title": "title",
|
||
"parameters": {
|
||
"surveyId": {
|
||
"parameter": "surveyId"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/actions1/surveys/{surveyId}/responses/{responseId}/details": {
|
||
"get": {
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"description": "The response identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"recipient_id": {
|
||
"description": "The recipient identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collection_mode": {
|
||
"description": "Response collection mode.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collection Mode",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"response_status": {
|
||
"description": "Status of the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response Status",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"custom_value": {
|
||
"description": "Custom value associated with a response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Custom Value",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"first_name": {
|
||
"type": "string",
|
||
"description": "First name of the recipient.",
|
||
"title": "First Name"
|
||
},
|
||
"last_name": {
|
||
"type": "string",
|
||
"description": "Last name of the recipient.",
|
||
"title": "Last Name"
|
||
},
|
||
"email_address": {
|
||
"type": "string",
|
||
"description": "Email Address of the recipient.",
|
||
"title": "Email Address"
|
||
},
|
||
"ip_address": {
|
||
"type": "string",
|
||
"description": "IP address of responder.",
|
||
"title": "IP Address"
|
||
},
|
||
"collector_id": {
|
||
"type": "string",
|
||
"description": "The collector identifier.",
|
||
"title": "Collector ID"
|
||
},
|
||
"survey_id": {
|
||
"type": "string",
|
||
"description": "The survey identifier.",
|
||
"title": "Survey ID"
|
||
},
|
||
"edit_url": {
|
||
"type": "string",
|
||
"description": "Link to the survey page to edit the response.",
|
||
"title": "Edit Url"
|
||
},
|
||
"analyze_url": {
|
||
"type": "string",
|
||
"description": "Link to the analyze page to view the response.",
|
||
"title": "Analyze Url"
|
||
},
|
||
"total_time": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "Total time spent on the response.",
|
||
"title": "Time Spent"
|
||
},
|
||
"date_modified": {
|
||
"type": "string",
|
||
"description": "The date the response was last modified.",
|
||
"title": "Modified Date"
|
||
},
|
||
"date_created": {
|
||
"type": "string",
|
||
"description": "The date the response was created.",
|
||
"title": "Created Date"
|
||
},
|
||
"href": {
|
||
"type": "string",
|
||
"description": "Survey response link.",
|
||
"title": "Link"
|
||
},
|
||
"RawResponseData": {
|
||
"type": "string",
|
||
"description": "CSV output of the response.",
|
||
"title": "Raw Response Data"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"description": "Export detailed response and survey data in CSV format. This premium feature is currently open to certain SurveyMonkey plans for a limited time.",
|
||
"operationId": "GetResponseDetails",
|
||
"summary": "Get Response Details in CSV Format",
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"description": "Select a survey"
|
||
},
|
||
{
|
||
"name": "responseId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"description": "Select a response"
|
||
},
|
||
{
|
||
"name": "simple",
|
||
"in": "query",
|
||
"required": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Simple",
|
||
"default": true,
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
{
|
||
"name": "question_ids",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"x-ms-summary": "Question IDs",
|
||
"x-ms-visibility": "advanced",
|
||
"description": "Filter the response details to specific questions. Use comma separator for multiple question IDs."
|
||
}
|
||
],
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"/surveys/{surveyId}/responses/{responseId}": {},
|
||
"/actions2/surveys/{surveyId}/responses/{responseId}/details": {
|
||
"get": {
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"description": "The response identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"recipient_id": {
|
||
"description": "The recipient identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collection_mode": {
|
||
"description": "Response collection mode.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collection Mode",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"response_status": {
|
||
"description": "Status of the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response Status",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"custom_value": {
|
||
"description": "Custom value associated with a response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Custom Value",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"first_name": {
|
||
"type": "string",
|
||
"description": "First name of the recipient.",
|
||
"title": "First Name"
|
||
},
|
||
"last_name": {
|
||
"type": "string",
|
||
"description": "Last name of the recipient.",
|
||
"title": "Last Name"
|
||
},
|
||
"email_address": {
|
||
"type": "string",
|
||
"description": "Email Address of the recipient.",
|
||
"title": "Email Address"
|
||
},
|
||
"ip_address": {
|
||
"type": "string",
|
||
"description": "IP address of responder.",
|
||
"title": "IP Address"
|
||
},
|
||
"collector_id": {
|
||
"type": "string",
|
||
"description": "The collector identifier.",
|
||
"title": "Collector ID"
|
||
},
|
||
"survey_id": {
|
||
"type": "string",
|
||
"description": "The survey identifier.",
|
||
"title": "Survey ID"
|
||
},
|
||
"edit_url": {
|
||
"type": "string",
|
||
"description": "Link to the survey page to edit the response.",
|
||
"title": "Edit Url"
|
||
},
|
||
"analyze_url": {
|
||
"type": "string",
|
||
"description": "Link to the analyze page to view the response.",
|
||
"title": "Analyze Url"
|
||
},
|
||
"total_time": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "Total time spent on the response.",
|
||
"title": "Time Spent"
|
||
},
|
||
"date_modified": {
|
||
"type": "string",
|
||
"description": "The date the response was last modified.",
|
||
"title": "Modified Date"
|
||
},
|
||
"date_created": {
|
||
"type": "string",
|
||
"description": "The date the response was created.",
|
||
"title": "Created Date"
|
||
},
|
||
"href": {
|
||
"type": "string",
|
||
"description": "Survey response link.",
|
||
"title": "Link"
|
||
},
|
||
"questions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"description": "The question identifier.",
|
||
"title": "Question ID"
|
||
},
|
||
"answers": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_data": {
|
||
"type": "array",
|
||
"items": {},
|
||
"description": "Answer Tag Data",
|
||
"title": "Answer Tag Data"
|
||
},
|
||
"text": {
|
||
"type": "string",
|
||
"description": "Answer Text",
|
||
"title": "Answer Text"
|
||
},
|
||
"simple_text": {
|
||
"type": "string",
|
||
"description": "Answer Simple Text",
|
||
"title": "Answer Simple Text"
|
||
}
|
||
}
|
||
},
|
||
"description": "Answers",
|
||
"title": "Answers"
|
||
},
|
||
"family": {
|
||
"type": "string",
|
||
"description": "The type of question.",
|
||
"title": "Question Family"
|
||
},
|
||
"subtype": {
|
||
"type": "string",
|
||
"description": "The subtype of the question.",
|
||
"title": "Question Subtype"
|
||
},
|
||
"heading": {
|
||
"type": "string",
|
||
"description": "The title of the question.",
|
||
"title": "Question Heading"
|
||
}
|
||
}
|
||
},
|
||
"description": "Questions",
|
||
"title": "Questions"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"summary": "Get Response Details in JSON Format",
|
||
"operationId": "GetResponseDetailsNoPages",
|
||
"parameters": [
|
||
{
|
||
"name": "surveyId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"description": "Select a survey"
|
||
},
|
||
{
|
||
"name": "responseId",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"description": "Select a response"
|
||
},
|
||
{
|
||
"name": "simple",
|
||
"in": "query",
|
||
"required": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Simple",
|
||
"x-ms-visibility": "internal",
|
||
"default": true
|
||
},
|
||
{
|
||
"name": "question_ids",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"x-ms-summary": "Question IDs",
|
||
"description": "Filter the response details to specific questions. Use comma separator for multiple question IDs.",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
],
|
||
"description": "Export detailed response and survey data in JSON format. This premium feature is currently open to certain SurveyMonkey plans for a limited time."
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"Surveys": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"href": {
|
||
"description": "Link to the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The survey identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"title": {
|
||
"description": "The title of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Title",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"SurveyCollectors": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"href": {
|
||
"description": "Link to collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"name": {
|
||
"description": "The name of the collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"id": {
|
||
"description": "The collector identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"SurveyCollector": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status": {
|
||
"description": "The status of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Status",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"redirect_url": {
|
||
"description": "Redirect to this url upon survey completion.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey Redirect Url",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"thank_you_message": {
|
||
"description": "Message for thank you page.",
|
||
"type": "string",
|
||
"x-ms-summary": "Thank You Message",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"response_count": {
|
||
"format": "int32",
|
||
"description": "The number of survey responses.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Response Count",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"closed_page_message": {
|
||
"description": "Message shown when a survey is closed.",
|
||
"type": "string",
|
||
"x-ms-summary": "Closed Message",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"href": {
|
||
"description": "Link to the survey collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"close_date": {
|
||
"description": "Close date of collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Close Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The collector identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"name": {
|
||
"description": "The name of the collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"date_modified": {
|
||
"format": "date-time",
|
||
"description": "The date the collector was last modified.",
|
||
"type": "string",
|
||
"x-ms-summary": "Modified Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"edit_response_type": {
|
||
"description": "Type of response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response Type",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"sender_email": {
|
||
"description": "Collector sender email.",
|
||
"type": "string",
|
||
"x-ms-summary": "Sender Email",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_created": {
|
||
"format": "date-time",
|
||
"description": "The date the collector was created.",
|
||
"type": "string",
|
||
"x-ms-summary": "Created Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"disqualification_message": {
|
||
"description": "Message for disqualification page.",
|
||
"type": "string",
|
||
"x-ms-summary": "Disqualification Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"type": {
|
||
"description": "Collector type: 'weblink’ or 'email’.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector Type",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
},
|
||
"Survey": {
|
||
"type": "object",
|
||
"properties": {
|
||
"response_count": {
|
||
"format": "int32",
|
||
"description": "Number of responses survey has received.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Response Count",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"page_count": {
|
||
"format": "int32",
|
||
"description": "Number of pages in the survey.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Page Count",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The survey identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"question_count": {
|
||
"format": "int32",
|
||
"description": "Number of questions in survey.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Question Count",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"category": {
|
||
"description": "Survey category chosen when creating the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey Category",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"preview": {
|
||
"description": "Survey preview URL.",
|
||
"type": "string",
|
||
"x-ms-summary": "Preview Url",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"language": {
|
||
"description": "Survey language.",
|
||
"type": "string",
|
||
"x-ms-summary": "Language",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_modified": {
|
||
"format": "date-time",
|
||
"description": "The date the survey was last modified.",
|
||
"type": "string",
|
||
"x-ms-summary": "Modified Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"title": {
|
||
"description": "The title of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Title",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"analyze_url": {
|
||
"description": "The URL for the results of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Analyze Url",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"summary_url": {
|
||
"description": "The URL for the summary of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Summary Url",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"date_created": {
|
||
"format": "date-time",
|
||
"description": "The date the survey was created.",
|
||
"type": "string",
|
||
"x-ms-summary": "Created Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collect_url": {
|
||
"description": "Survey collect URL.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collect Url",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"edit_url": {
|
||
"description": "Survey edit URL.",
|
||
"type": "string",
|
||
"x-ms-summary": "Edit Url",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
},
|
||
"SurveyMessages": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status": {
|
||
"description": "The status of the message.",
|
||
"type": "string",
|
||
"x-ms-summary": "Message status",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"href": {
|
||
"description": "Link to message.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"type": {
|
||
"description": "Type of message.",
|
||
"type": "string",
|
||
"x-ms-summary": "Type",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The message identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Message ID",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"SurveyMessageResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"is_scheduled": {
|
||
"description": "Link to message results.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"scheduled_date": {
|
||
"format": "date-time",
|
||
"description": "Date message was scheduled to be sent.",
|
||
"type": "string",
|
||
"x-ms-summary": "Scheduled Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"body": {
|
||
"description": "The plain text body of the email message to be sent to recipients.",
|
||
"type": "string",
|
||
"x-ms-summary": "Message Body",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"subject": {
|
||
"description": "Subject of the email message to be sent to recipients.",
|
||
"type": "string",
|
||
"x-ms-summary": "Subject",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"recipients": {
|
||
"description": "List of recipient ids.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"x-ms-summary": "Recipients",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"recipient_status": {
|
||
"description": "The recipient status.",
|
||
"type": "string",
|
||
"x-ms-summary": "States",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
}
|
||
},
|
||
"NewSurveys": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"href": {
|
||
"description": "Link to the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The survey identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"title": {
|
||
"description": "The title of the survey.",
|
||
"type": "string",
|
||
"x-ms-summary": "Title",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"NewCollectors": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"href": {
|
||
"description": "Link to survey collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The collector identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"name": {
|
||
"description": "The name of the collector.",
|
||
"type": "string",
|
||
"x-ms-summary": "Name",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"SurveyResponses": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"total_time": {
|
||
"format": "int32",
|
||
"description": "Total time spent on the response.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Time Spent",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"href": {
|
||
"description": "Survey response link.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"ip_address": {
|
||
"description": "IP address of responder.",
|
||
"type": "string",
|
||
"x-ms-summary": "IP Address",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The response identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_modified": {
|
||
"format": "date-time",
|
||
"description": "The date the response was last modified.",
|
||
"type": "string",
|
||
"x-ms-summary": "Modified Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"response_status": {
|
||
"description": "Status of the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response Status",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"custom_value": {
|
||
"description": "Custom value associated with a response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Custom Value",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"analyze_url": {
|
||
"description": "Link to the analyze page to view the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Analyze Url",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"recipient_id": {
|
||
"description": "The recipient identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collector_id": {
|
||
"description": "The collector identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_created": {
|
||
"format": "date-time",
|
||
"description": "The date the response was created.",
|
||
"type": "string",
|
||
"x-ms-summary": "Created Date",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"survey_id": {
|
||
"description": "The survey identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collection_mode": {
|
||
"description": "Response collection mode.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collection Mode",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"first_name": {
|
||
"type": "string",
|
||
"description": "First name of the recepient.",
|
||
"x-ms-summary": "First Name",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"last_name": {
|
||
"type": "string",
|
||
"description": "Last name of the recepient.",
|
||
"x-ms-summary": "Last Name",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_address": {
|
||
"type": "string",
|
||
"description": "Email Address of the recepient.",
|
||
"x-ms-summary": "Email Address",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"logic_path": {
|
||
"type": "object",
|
||
"properties": {},
|
||
"description": "Logic path taken during the survey."
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"contact": {
|
||
"type": "object",
|
||
"properties": {},
|
||
"description": "contact"
|
||
}
|
||
},
|
||
"description": "Other associated metadata or custom values."
|
||
},
|
||
"page_path": {
|
||
"type": "array",
|
||
"items": {},
|
||
"description": "The order in which the pages were responded to."
|
||
},
|
||
"pages": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"description": "Page ID",
|
||
"x-ms-summary": "Page ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"questions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Question ID",
|
||
"description": "Question ID"
|
||
},
|
||
"answers": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choice_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Choice ID",
|
||
"description": "Choice ID"
|
||
}
|
||
}
|
||
},
|
||
"description": "Answers"
|
||
}
|
||
}
|
||
},
|
||
"description": "Questions"
|
||
}
|
||
}
|
||
},
|
||
"description": "Pages from the survey and their associated responses."
|
||
},
|
||
"edit_url": {
|
||
"description": "Link to the survey page to edit the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Edit Url",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"SurveyResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"total_time": {
|
||
"format": "int32",
|
||
"description": "Total time spent on the response.",
|
||
"type": "integer",
|
||
"x-ms-summary": "Time Spent",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"href": {
|
||
"description": "Survey response link.",
|
||
"type": "string",
|
||
"x-ms-summary": "Link",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"ip_address": {
|
||
"description": "IP address of responder.",
|
||
"type": "string",
|
||
"x-ms-summary": "IP Address",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "The response identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_modified": {
|
||
"format": "date-time",
|
||
"description": "The date the response was last modified.",
|
||
"type": "string",
|
||
"x-ms-summary": "Modified Date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"response_status": {
|
||
"description": "Status of the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Response Status",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"custom_value": {
|
||
"description": "Custom value associated with a response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Custom Value",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"analyze_url": {
|
||
"description": "Link to the analyze page to view the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Analyze Url",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"recipient_id": {
|
||
"description": "The recipient identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collector_id": {
|
||
"description": "The collector identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collector ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"date_created": {
|
||
"format": "date-time",
|
||
"description": "The date the response was created.",
|
||
"type": "string",
|
||
"x-ms-summary": "Created Date",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"survey_id": {
|
||
"description": "The survey identifier.",
|
||
"type": "string",
|
||
"x-ms-summary": "Survey ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"collection_mode": {
|
||
"description": "Response collection mode.",
|
||
"type": "string",
|
||
"x-ms-summary": "Collection Mode",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"first_name": {
|
||
"type": "string",
|
||
"description": "First name of the recepient.",
|
||
"x-ms-summary": "First Name",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"last_name": {
|
||
"type": "string",
|
||
"description": "Last name of the recepient.",
|
||
"x-ms-summary": "Last Name",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_address": {
|
||
"type": "string",
|
||
"description": "Email Address of the recepient.",
|
||
"x-ms-summary": "Email Address",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"logic_path": {
|
||
"type": "object",
|
||
"properties": {},
|
||
"description": "Logic path taken during the survey."
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"contact": {
|
||
"type": "object",
|
||
"properties": {},
|
||
"description": "contact"
|
||
}
|
||
},
|
||
"description": "Other associated metadata or custom values."
|
||
},
|
||
"page_path": {
|
||
"type": "array",
|
||
"items": {},
|
||
"description": "The order in which the pages were responded to."
|
||
},
|
||
"pages": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"description": "Page ID",
|
||
"x-ms-summary": "Page ID"
|
||
},
|
||
"questions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Question ID",
|
||
"description": "Question ID"
|
||
},
|
||
"answers": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choice_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Choice ID",
|
||
"description": "Choice ID"
|
||
}
|
||
}
|
||
},
|
||
"description": "Answers"
|
||
}
|
||
}
|
||
},
|
||
"description": "Questions"
|
||
}
|
||
}
|
||
},
|
||
"description": "Pages from the survey and their associated responses."
|
||
},
|
||
"edit_url": {
|
||
"description": "Link to the survey page to edit the response.",
|
||
"type": "string",
|
||
"x-ms-summary": "Edit Url",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"parameters": {},
|
||
"responses": {},
|
||
"tags": [],
|
||
"x-ms-capabilities": {
|
||
"testConnection": {
|
||
"operationId": "GetSurveys"
|
||
}
|
||
},
|
||
"x-ms-connector-metadata": [
|
||
{
|
||
"propertyName": "Website",
|
||
"propertyValue": "https://www.surveymonkey.com/"
|
||
},
|
||
{
|
||
"propertyName": "Privacy policy",
|
||
"propertyValue": "https://www.surveymonkey.com/mp/legal/privacy-policy/"
|
||
},
|
||
{
|
||
"propertyName": "Categories",
|
||
"propertyValue": "Content and Files;Productivity"
|
||
}
|
||
]
|
||
}
|