Skip to main content
GET
/
surveys
/
{id}
Get survey
curl --request GET \
  --url https://api.pickfu.com/v1/surveys/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "country": "<string>",
    "sampleSize": 123,
    "numResponses": 123,
    "status": "<string>",
    "targeting": [
      "<string>"
    ],
    "reporting": [
      "<string>"
    ],
    "tags": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "project": {
      "id": "<string>",
      "name": "<string>"
    },
    "surveyUrl": "<string>",
    "surveyIntent": "<string>",
    "questions": [
      {
        "id": "<string>",
        "type": "<string>",
        "variant": "<string>",
        "value": "<string>",
        "translation": "<string>",
        "options": [
          {
            "id": "<string>",
            "label": "<string>",
            "value": "<string>",
            "type": "<string>",
            "translation": "<string>",
            "product": {
              "asin": "<string>",
              "title": "<string>",
              "price": 123,
              "rating": 123,
              "reviews": 123,
              "image": "<string>"
            },
            "imageSetDirection": "<string>",
            "mockupType": "<string>"
          }
        ],
        "context": {
          "type": "<string>",
          "value": "<string>",
          "translation": "<string>"
        },
        "responses": [
          {
            "id": "<string>",
            "explanation": "<string>",
            "translation": "<string>",
            "chosenOption": "<string>",
            "score": 123,
            "clicks": [
              {
                "number": 123,
                "xCoord": 123,
                "yCoord": 123
              }
            ],
            "rounds": [
              {
                "number": 123,
                "option": "<string>"
              }
            ],
            "media": "<string>",
            "mediaTranscription": "<string>",
            "matchup": {
              "option1": "<string>",
              "option2": "<string>"
            },
            "respondent": [
              {
                "trait": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "ai": {}
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}

Path Parameters

id
string
required

Survey GUID

questionId
string | null
required

Filter to a specific question by its GUID

language
string | null
required

Language code for response translations (e.g. ES, FR, DE)

Response

200 - application/json

Default Response

data
object

Full survey data including questions, options, and metadata