Example of a connection in Postman
- Pieter Hotke
Prerequisites
First, get your API credentials. See Where to create API credentials? .
Create x-auth-token
Open https://developer.mopinion.com/credential-checker.php .
Use Public key (A)
as the Public Key (A)
and Token (C)
as the Signature token (C)
in our API Credential Checker.
Depending on the Resource endpoint (E)
, see https://developer.mopinion.com/ for an overview of the available endpoints, set the Resource endpoint (E)
.
Depending on the Resource endpoint (E)
set the Request Method (D)
to GET
, POST
, PUT
, DELETE
, or OPTIONS
. Most endpoints only support the GET
method.
When all is set you will get a unique x-auth-token (F)
for this request to set in the header of your request.
Example
To demonstrate the configuration of the endpoints and output we use the form https://example.mopinion.com/r/data-collection/survey/edit/4/web/detail in report Integrations
. Public landingpage https://example.mopinion.com/survey/public/take-survey/a958c693f143483d3da418c097181ab8a4e393f1
Â
And deployment code https://example.mopinion.com/r/data-collection/deployment/edit/z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s/web .
Running on https://sample.mopinion.com/integrations/.
Useful properties are the form id 4
and deployment code z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s
.
Endpoints
Account
Configuration
Endpoint: https://api.mopinion.com/account
API documentation: https://developer.mopinion.com/#tag/account%2Fpaths%2F~1account%2Fget
x-auth-token: OGUxNDBjN2ZmZTVkZDFhOmE0OThkNGE5N2I5NTU1ZDI0OTcyODdjMzhmMjcxMDYwZDIyZmIxNDhiMGRlZDFjMzdlYWIyYjk0NjI2YWI5MjI=
Postman interface
Â
Output
{
"name": "Example",
"package": "Enterprise",
"enddate": "2025-02-03 13:41:45",
"number_users": 110,
"number_charts": 59,
"number_forms": 45,
"number_reports": 101,
"reports": [
{
"name": "Example",
"description": "Main account project",
"language": "en_US",
"id": 1,
"dataSets": [],
"created": "2023-02-03"
},
{
"name": "Form elements",
"description": "Per form one element",
"language": "en_US",
"id": 4,
"dataSets": [
{
"name": "Numeric rating",
"report_id": 4,
"description": "",
"id": 5,
"data_source": "form"
},
{
"name": "Star rating",
"report_id": 4,
"description": "",
"id": 6,
"data_source": "form"
},
{
"name": "Smiley rating",
"report_id": 4,
"description": "",
"id": 7,
"data_source": "form"
},
{
"name": "Bar rating",
"report_id": 4,
"description": "",
"id": 8,
"data_source": "form"
},
{
"name": "Net Promotor Score",
"report_id": 4,
"description": "",
"id": 9,
"data_source": "form"
},
{
"name": "Customer Effort Score",
"report_id": 4,
"description": "",
"id": 10,
"data_source": "form"
},
{
"name": "Goal Completion Rate",
"report_id": 4,
"description": "",
"id": 11,
"data_source": "form"
},
{
"name": "Thumbs",
"report_id": 4,
"description": "",
"id": 12,
"data_source": "form"
},
{
"name": "Single Line Input",
"report_id": 4,
"description": "",
"id": 13,
"data_source": "form"
},
{
"name": "Textarea",
"report_id": 4,
"description": "",
"id": 14,
"data_source": "form"
},
{
"name": "Radio Button",
"report_id": 4,
"description": "",
"id": 15,
"data_source": "form"
},
{
"name": "Checkbox",
"report_id": 4,
"description": "",
"id": 16,
"data_source": "form"
},
{
"name": "Contact details",
"report_id": 4,
"description": "",
"id": 17,
"data_source": "form"
},
{
"name": "Dropdown",
"report_id": 4,
"description": "",
"id": 18,
"data_source": "form"
},
{
"name": "Categories",
"report_id": 4,
"description": "",
"id": 19,
"data_source": "form"
},
{
"name": "Screenshot",
"report_id": 4,
"description": "",
"id": 20,
"data_source": "form"
},
{
"name": "Website data",
"report_id": 4,
"description": "",
"id": 21,
"data_source": "form"
},
{
"name": "Likert",
"report_id": 4,
"description": "",
"id": 22,
"data_source": "form"
},
{
"name": "Matrix",
"report_id": 4,
"description": "",
"id": 23,
"data_source": "form"
},
{
"name": "Link",
"report_id": 4,
"description": "",
"id": 24,
"data_source": "form"
},
{
"name": "Multimedia",
"report_id": 4,
"description": "",
"id": 25,
"data_source": "form"
},
{
"name": "Section break",
"report_id": 4,
"description": "",
"id": 26,
"data_source": "form"
},
{
"name": "Page break",
"report_id": 4,
"description": "",
"id": 27,
"data_source": "form"
},
{
"name": "Custom front page",
"report_id": 4,
"description": "",
"id": 28,
"data_source": "form"
},
{
"name": "Text bubble",
"report_id": 4,
"description": "",
"id": 29,
"data_source": "form"
},
{
"name": "Numeric rating",
"report_id": 4,
"description": "",
"id": 30,
"data_source": "form"
},
{
"name": "Star rating",
"report_id": 4,
"description": "",
"id": 31,
"data_source": "form"
}
],
"created": "2023-09-07"
},
{
"name": "Integrations",
"description": "Feedback forms that demonstrate the integrations",
"language": "en_US",
"id": 3,
"dataSets": [
{
"name": "All elements GA4",
"report_id": 3,
"description": "",
"id": 4,
"data_source": "form"
}
],
"created": "2023-09-05"
},
{
"name": "Native vs Web VIEW",
"description": "Compare the app forms in the different SDKs.",
"language": "en_US",
"id": 5,
"dataSets": [
{
"name": "Numeric rating",
"report_id": 5,
"description": "",
"id": 32,
"data_source": "form"
},
{
"name": "Star rating",
"report_id": 5,
"description": "",
"id": 33,
"data_source": "form"
},
{
"name": "Smiley rating",
"report_id": 5,
"description": "",
"id": 34,
"data_source": "form"
},
{
"name": "Bar rating",
"report_id": 5,
"description": "",
"id": 35,
"data_source": "form"
},
{
"name": "NPS",
"report_id": 5,
"description": "",
"id": 36,
"data_source": "form"
},
{
"name": "CES",
"report_id": 5,
"description": "",
"id": 37,
"data_source": "form"
},
{
"name": "GCR",
"report_id": 5,
"description": "",
"id": 38,
"data_source": "form"
},
{
"name": "Thumbs",
"report_id": 5,
"description": "",
"id": 39,
"data_source": "form"
},
{
"name": "Single line",
"report_id": 5,
"description": "",
"id": 40,
"data_source": "form"
},
{
"name": "Textarea",
"report_id": 5,
"description": "",
"id": 41,
"data_source": "form"
},
{
"name": "Radio button",
"report_id": 5,
"description": "",
"id": 42,
"data_source": "form"
},
{
"name": "Checkbox",
"report_id": 5,
"description": "",
"id": 43,
"data_source": "form"
},
{
"name": "Contact details - default",
"report_id": 5,
"description": "",
"id": 44,
"data_source": "form"
},
{
"name": "Contact details - all fields - not required - tooltip",
"report_id": 5,
"description": "",
"id": 45,
"data_source": "form"
},
{
"name": "Contact details - all fields - required - tooltip",
"report_id": 5,
"description": "",
"id": 46,
"data_source": "form"
},
{
"name": "Contact details - Combined - Business",
"report_id": 5,
"description": "",
"id": 47,
"data_source": "form"
},
{
"name": "Contact details - Hidden",
"report_id": 5,
"description": "",
"id": 48,
"data_source": "form"
},
{
"name": "Dropdown select",
"report_id": 5,
"description": "",
"id": 49,
"data_source": "form"
},
{
"name": "Screenshot - default",
"report_id": 5,
"description": "",
"id": 50,
"data_source": "form"
},
{
"name": "Screenshot - required",
"report_id": 5,
"description": "",
"id": 51,
"data_source": "form"
},
{
"name": "Screenshot - upload - tooltip",
"report_id": 5,
"description": "",
"id": 52,
"data_source": "form"
},
{
"name": "Screenshot - hidden",
"report_id": 5,
"description": "",
"id": 53,
"data_source": "form"
},
{
"name": "Link",
"report_id": 5,
"description": "",
"id": 54,
"data_source": "form"
},
{
"name": "Link - Form action",
"report_id": 5,
"description": "",
"id": 55,
"data_source": "form"
},
{
"name": "Multimedia",
"report_id": 5,
"description": "",
"id": 56,
"data_source": "form"
},
{
"name": "Section break",
"report_id": 5,
"description": "",
"id": 57,
"data_source": "form"
},
{
"name": "Page break - no other elements",
"report_id": 5,
"description": "",
"id": 58,