Olery Developer Portal logo Olery Developer Portal

Method Path
GET https://agora.olery.com/v3/feedback/surveys

This endpoint returns all surveys linked to the feedback contract.

Output Format

The aggregated data is returned as an Array of JSON objects in the data field. Each object has the following fields:

Field Data Types Description
id String Survey’s ID
name String Survey’s Name
title String Survey’s Title
instructions String Survey’s Instructions
published Boolean Survey’s status (active or inactive)
responses_count Array Array of hashes where each hash has a company ID and the number of responses for that company
company_ids Array Array of integers where each element indicates a company linked to the survey
translations Hash See Translations Fields section
languages Array See Languages Fields section

Translations Fields

The translation field is a hash where each key is a language code. Each key has a hash with the following fields:

Field Data Types Description
title String Survey’s title in that language
thankyou String Survey’s thank you message in that language
instructions String Survey’s instructions in that language

Languages Fields

The languages field is an array of hashes. Each hash represents a language and has the following fields:

Field Data Types Description
code String Language’s code
name String Language’s name

Example Output

{
  "data": [
    {
      "id": "8d35d48295h53f40ece59fbda",
      "name": "Demo Survey 1",
      "title": "Give us feedback",
      "instructions": null,
      "published": true,
      "responses_count": [
        {
          "company_id": 8347788,
          "count": 76
        },
        {
          "company_id": 9257918,
          "count": 29
        }
      ],
      "company_ids": [8347788, 9257918],
      "translations": {
        "en": {
          "title": "Please, give us your opinion",
          "thankyou": "Thank you!",
          "instructions": "We are very interested to hear what you think."
        }
      },
      "languages": [
        {
          "code": "en",
          "name": "English"
        }
      ]
    },
    {
      "id": "a0e0476ddcc9c2b4123453636",
      "name": "Demo Survey 2",
      "title": "Give us feedback",
      "instructions": null,
      "published": true,
      "responses_count": [
        {
          "company_id": 8347788,
          "count": 21
        }
      ],
      "company_ids": [8347788],
      "translations": {
        "en": {
          "title": "Give us feedbacks",
          "thankyou": "Thank you for giving us your opinion!",
          "instructions": "We are very interested to hear what you think. We would appreciate if you could spare a few moments to complete this survey."
        },
        "es": {
          "title": "Danos su opinión",
          "thankyou": "¡Gracias por darnos tu opinión!",
          "instructions": "Estamos muy interesados ​​en escuchar lo que piensas. Le agradeceríamos que nos dedicara unos minutos a completar esta encuesta."
        }
      },
      "languages": [
        {
          "code": "en",
          "name": "English"
        },
        {
          "code": "es",
          "name": "Spanish"
        }
      ]
    }
  ]
}