Data Export API API Reference

Use data export API to retrieve data gathered with Survicate.

API Endpoint
https://data-api.survicate.com/v1
Response Content-Types: application/json
Schemes: https
Version: 1.0.1

Authentication

ApiKey

Workspace API key in format 'Basic xxxx'

name
Authorization
type
apiKey
in
header

Paths

GET /surveys

Returns all surveys from the workspace

200 OK

Survey list

type
Response Example (200 OK)
[
  {
    "id": 12,
    "name": "My survey",
    "responses": 5143
  }
]

GET /surveys/{surveyId}/visitors

Returns all survey respondents

surveyId
in path
string

(no description)

200 OK

Visitors list

Response Example (200 OK)
[
  {
    "tags": [
      "intercom"
    ],
    "custom_attributes": {
      "consumer_id": "buyers"
    },
    "first_seen_date": "string (date-time)",
    "answers": [
      {
        "survey_point": {
          "id": 2542,
          "type": "SurveyQuestion",
          "pretty_type": "Single choice",
          "answer_type": "single"
        },
        "question": "What prevents you from signing up?",
        "content": "I can't find pricing details"
      }
    ],
    "first_name": "John",
    "last_name": "Smith",
    "email": "user@survicate.com",
    "organization": "Survicate",
    "department": "Tech",
    "job_title": "CEO",
    "phone": "726 566 455",
    "website": "string",
    "visitor_hash": "string",
    "country": "Poland",
    "address_one": "View street",
    "address_two": "24/35",
    "city": "Torun",
    "state": "Kuj-pom",
    "zip": "87-100",
    "fax": "+48 56 778 87 78",
    "annual_revenue": "12k USD",
    "employees": "12",
    "industry": "Software Development",
    "identity": "mf4io23n4oin234",
    "comment": "some comment",
    "visitor_id": 13
  }
]

GET /visitors/{visitorId}

Get visitor details (including responses)

visitorId
in path
string

(no description)

200 OK

Visitors list

Response Example (200 OK)
[
  {
    "tags": [
      "intercom"
    ],
    "custom_attributes": {
      "consumer_id": "buyers"
    },
    "first_seen_date": "string (date-time)",
    "reports": [
      {
        "survey_name": "Exit intent survey",
        "platform": "mobile",
        "date": "string (date-time)",
        "answers": [
          {
            "survey_point": {
              "id": 2542,
              "type": "SurveyQuestion",
              "pretty_type": "Single choice",
              "answer_type": "single"
            },
            "question": "What prevents you from signing up?",
            "content": "I can't find pricing details"
          }
        ]
      }
    ],
    "first_name": "John",
    "last_name": "Smith",
    "email": "user@survicate.com",
    "organization": "Survicate",
    "department": "Tech",
    "job_title": "CEO",
    "phone": "726 566 455",
    "website": "string",
    "country": "Poland",
    "address_one": "View street",
    "address_two": "24/35",
    "city": "Torun",
    "state": "Kuj-pom",
    "zip": "87-100",
    "fax": "+48 56 778 87 78",
    "annual_revenue": "12k USD",
    "employees": "12",
    "industry": "Software Development",
    "identity": "mf4io23n4oin234",
    "comment": "some comment"
  }
]

Schema Definitions

Survey: object

id: string
name: string
responses: integer
Example
{
  "id": 12,
  "name": "My survey",
  "responses": 5143
}

SurveyVisitor: object

tags: string[]
string
custom_attributes: string[]
string
first_seen_date: string (date-time)
answers: VisitorSurveyAnswer
VisitorSurveyAnswer
first_name: string
last_name: string
email: string
organization: string
department: string
job_title: string
phone: string
website: string
visitor_hash: string
country: string
address_one: string
address_two: string
city: string
state: string
zip: string
fax: string
annual_revenue: string
employees: string
industry: string
identity: string
comment: string
visitor_id: integer
Example
{
  "tags": [
    "intercom"
  ],
  "custom_attributes": {
    "consumer_id": "buyers"
  },
  "first_seen_date": "string (date-time)",
  "answers": [
    {
      "survey_point": {
        "id": 2542,
        "type": "SurveyQuestion",
        "pretty_type": "Single choice",
        "answer_type": "single"
      },
      "question": "What prevents you from signing up?",
      "content": "I can't find pricing details"
    }
  ],
  "first_name": "John",
  "last_name": "Smith",
  "email": "user@survicate.com",
  "organization": "Survicate",
  "department": "Tech",
  "job_title": "CEO",
  "phone": "726 566 455",
  "website": "string",
  "visitor_hash": "string",
  "country": "Poland",
  "address_one": "View street",
  "address_two": "24/35",
  "city": "Torun",
  "state": "Kuj-pom",
  "zip": "87-100",
  "fax": "+48 56 778 87 78",
  "annual_revenue": "12k USD",
  "employees": "12",
  "industry": "Software Development",
  "identity": "mf4io23n4oin234",
  "comment": "some comment",
  "visitor_id": 13
}

SingleVisitor: object

tags: string[]
string
custom_attributes: string[]
string
first_seen_date: string (date-time)
reports: VisitorSurveyReport
VisitorSurveyReport
first_name: string
last_name: string
email: string
organization: string
department: string
job_title: string
phone: string
website: string
country: string
address_one: string
address_two: string
city: string
state: string
zip: string
fax: string
annual_revenue: string
employees: string
industry: string
identity: string
comment: string
Example
{
  "tags": [
    "intercom"
  ],
  "custom_attributes": {
    "consumer_id": "buyers"
  },
  "first_seen_date": "string (date-time)",
  "reports": [
    {
      "survey_name": "Exit intent survey",
      "platform": "mobile",
      "date": "string (date-time)",
      "answers": [
        {
          "survey_point": {
            "id": 2542,
            "type": "SurveyQuestion",
            "pretty_type": "Single choice",
            "answer_type": "single"
          },
          "question": "What prevents you from signing up?",
          "content": "I can't find pricing details"
        }
      ]
    }
  ],
  "first_name": "John",
  "last_name": "Smith",
  "email": "user@survicate.com",
  "organization": "Survicate",
  "department": "Tech",
  "job_title": "CEO",
  "phone": "726 566 455",
  "website": "string",
  "country": "Poland",
  "address_one": "View street",
  "address_two": "24/35",
  "city": "Torun",
  "state": "Kuj-pom",
  "zip": "87-100",
  "fax": "+48 56 778 87 78",
  "annual_revenue": "12k USD",
  "employees": "12",
  "industry": "Software Development",
  "identity": "mf4io23n4oin234",
  "comment": "some comment"
}

VisitorSurveyAnswer: object

survey_point: VisitorSurveyAnswerSurveyPoint
question: string
content: string
Example
{
  "survey_point": {
    "id": 2542,
    "type": "SurveyQuestion",
    "pretty_type": "Single choice",
    "answer_type": "single"
  },
  "question": "What prevents you from signing up?",
  "content": "I can't find pricing details"
}

VisitorSurveyReport: object

survey_name: string
platform: string
date: string (date-time)
answers: VisitorSurveyAnswer
VisitorSurveyAnswer
Example
{
  "survey_name": "Exit intent survey",
  "platform": "mobile",
  "date": "string (date-time)",
  "answers": [
    {
      "survey_point": {
        "id": 2542,
        "type": "SurveyQuestion",
        "pretty_type": "Single choice",
        "answer_type": "single"
      },
      "question": "What prevents you from signing up?",
      "content": "I can't find pricing details"
    }
  ]
}

VisitorSurveyAnswerSurveyPoint: object

id: integer
type: string
pretty_type: string
answer_type: string
Example
{
  "id": 2542,
  "type": "SurveyQuestion",
  "pretty_type": "Single choice",
  "answer_type": "single"
}