GET
/
api
/
v1
/
portfolios
/
{id}
/
survey_download
/
Survey Download
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/portfolios/{id}/survey_download/ \
  --header 'Authorization: Bearer <token>'
{
  "mona_version": {
    "id": 123,
    "name": "<string>",
    "audience": "<string>",
    "audience_type": 0,
    "sequence": -1
  },
  "apex_questions": [
    "<string>"
  ],
  "survey_brand_name": "<string>",
  "audience_fee_language": "fees",
  "audience_interacts_with_staff": true,
  "audience_pays_directly": true,
  "audience_type": 123,
  "audience_type_str": "customers",
  "survey_config_confirmed": true,
  "survey_override_brand_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
download_format
enum<string>
default:txt
  • txt - txt
  • docx - docx
Available options:
txt,
docx

Response

200 - application/json

This serializer is mostly built within the Survey.to_serializer() method because it is NOT a model serializer and its properties are set menually by that controlling object.

The serializer allows READ on many properties including the JSON representation of the survey. It also allows WRITE on some of the portfolio properties that influence the survey structure.

If you make changes to the fields here, you should also look at the Survey.get_serializer_data() method to see if you need to update that as well

​
mona_version
object
required
​
apex_questions
string[]
required
​
survey_brand_name
string
required
Maximum length: 200
​
audience_type
integer
required
​
audience_fee_language
enum<string>
  • fees - fees
  • prices - prices
Available options:
fees,
prices
​
audience_interacts_with_staff
boolean
​
audience_pays_directly
boolean
​
audience_type_str
enum<string>
  • customers - customers
  • employees - employees
  • donors - donors
  • media - media
  • gathering 2024 lecturees - gathering 2024 lecturees
Available options:
customers,
employees,
donors,
media,
gathering 2024 lecturees
​
survey_config_confirmed
boolean
​
survey_override_brand_name
string
Maximum length: 200