Definition

GET - 3/lookup/metadataTypes?lang={lang}

Retrieve the list of metadata types

Response cached for 86400 seconds.
1 first_name
2 last_name
70 full_name
3 e_mail
62 contact_lang_code
10 street
11 house_number
12 suite
13 postal_code
14 city
15 state
16 province
17 country_id
18 phone
19 gender
20 date_of_birth
5 optional_1
6 optional_2
7 optional_3
8 optional_4
9 optional_5
21 optional_6
22 optional_7
23 optional_8
24 optional_9
25 optional_10
26 optional_11
27 optional_12
28 optional_13
29 optional_14
30 optional_15
31 optional_16
32 optional_17
33 optional_18
34 optional_19
35 optional_20
39 date_created
40 date_modified
42 date_added
47 date_bounced
48 date_optout
49 date_mailed
50 date_clicked_through
51 date_reminded
52 date_report_sent
53 panelist_status_id
57 contact_count
60 contact_id
61 date_saw_email
63 date_reminded_partial
64 date_reminded_2
65 date_thank_you_mail_sent
66 date_to_be_mailed
67 date_to_expire
71 survey_url
72 contact_report_url
69 contacts
4 lang_code
36 elapsed_time
37 distribution_method
38 end_status_id
41 date_responded
43 panelId
44 country_code
45 browser
46 operating_system
54 score
55 score_perc
73 respondent_report_url
56 respondent_count
58 is_contact
59 result_set_id
68 respondents
74 referrer
75 exit_page_num
76 continent_code
77 ip_city
78 is_mobile
79 respondent_edit_url
80 completion_percentage

Request information

lang

Type string
Additional info
Optional

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of SimpleLookup
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas
Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-02-24T00:27:55.6752248Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ]
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <SimpleLookup z:Id="i2">
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </SimpleLookup>
    <SimpleLookup z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-02-24T00:27:55.6752248+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>