Example of a connection in Postman

Prerequisites

First, get your API credentials. See .

Create x-auth-token

Open https://developer.mopinion.com/credential-checker.php .

Use Public key (A) as the Public Key and Token (C) as the Signature token in our API Credential Checker.

Depending on the Resource endpoint, see https://developer.mopinion.com/ for an overview of the available endpoints, set the Resource endpoint to GET, POST, PUT, DELETE, or OPTIONS

image-20240311-144428.png

When all is set you will get a unique x-auth-token for this request to set in the header in 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

 

And deployment code https://example.mopinion.com/r/data-collection/deployment/edit/z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s/web .

Running on .

Useful properties are the form id 4 and deployment code z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s.

Endpoints

Account

Configuration

Endpoint: https://api.mopinion.com/account

API documentation:

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, "data_source": "form" }, { "name": "Page break", "report_id": 5, "description": "", "id": 59, "data_source": "form" }, { "name": "Send button", "report_id": 5, "description": "", "id": 60, "data_source": "form" }, { "name": "Send button - hidden", "report_id": 5, "description": "", "id": 61, "data_source": "form" }, { "name": "Send button - autopost after last question", "report_id": 5, "description": "", "id": 62, "data_source": "form" }, { "name": "Send button - hidden - autopost after last closed question", "report_id": 5, "description": "", "id": 63, "data_source": "form" }, { "name": "Send button - hidden - autopost after last open question", "report_id": 5, "description": "", "id": 64, "data_source": "form" }, { "name": "Header - progress Bar - one page", "report_id": 5, "description": "", "id": 65, "data_source": "form" }, { "name": "Header - progress Dots - one page", "report_id": 5, "description": "", "id": 66, "data_source": "form" }, { "name": "Header - progress Bar - multiple pages", "report_id": 5, "description": "", "id": 67, "data_source": "form" }, { "name": "Header - progress Dots - multiple pages", "report_id": 5, "description": "", "id": 68, "data_source": "form" }, { "name": "Thankspage - default", "report_id": 5, "description": "", "id": 70, "data_source": "form" }, { "name": "Thankspage - Own text", "report_id": 5, "description": "", "id": 71, "data_source": "form" }, { "name": "Thankspage - No text", "report_id": 5, "description": "", "id": 72, "data_source": "form" }, { "name": "Thankspage - Auto close", "report_id": 5, "description": "", "id": 73, "data_source": "form" }, { "name": "Send button - No thankspage", "report_id": 5, "description": "", "id": 74, "data_source": "form" } ], "created": "2023-10-11" }, { "name": "Sandbox", "description": "Feedback from the forms that run on the path name sandbox.", "language": "en_US", "id": 2, "dataSets": [ { "name": "deployment conditions", "report_id": 2, "description": "", "id": 1, "data_source": "form" }, { "name": "NPS", "report_id": 2, "description": "", "id": 2, "data_source": "form" }, { "name": "NPS already filled thankpage", "report_id": 2, "description": "", "id": 3, "data_source": "form" } ], "created": "2023-04-11" } ], "_meta": { "code": 200, "message": "OK", "has_more": false, "previous": false, "next": false, "count": 1, "total": 1 } }

Deployments

Configuration

Endpoint: https://api.mopinion.com/deployments/z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s ← https://api.mopinion.com/deployments/{deployment-id}

API documentation:

x-auth-token: OGUxNDBjN2ZmZTVkZDFhOmFiOTA1M2Y5YmY4OGJmNjM3YTcxMGI4MzEwZGYzMTkxNmNkZmUwYThmZDUzOTA1Njk3NDMzMGE2Mjk1ZTRkYWE=

Postman interface

Output

{ "domain": "example.mopinion.com", "id": "z4CxctMLgIz6n2iLmqZxXu7XMGVSIWyPbn14j54s", "org_id": 1, "name": "Integrations", "published": true, "type": "web", "rules": [ { "id": "agual7cq3k5mx995jfkmckyq10trf72s", "if": [ { "trigger": "passive", "percentage": 100, "time": null, "time_in_session": null, "location": [], "js": [], "cookie": [], "referrer": [], "scrollpos": [], "number_of_pages": [], "type": null, "devices": [], "session": 30, "css_selector": [], "date": [], "clock": [], "pause": false } ], "then": [ { "service": "mopinion", "args": [ "a958c693f143483d3da418c097181ab8a4e393f1", "example.mopinion.com", "surveyContent" ], "disableMakeDiv": false, "useQuerySelectorAll": false } ] } ], "deployed": true, "token": "54f153be8890d22cddf4d729c8007674702cff45179974ba6e8396d565ebbae3", "_meta": { "code": 200, "message": "OK", "has_more": false, "previous": false, "next": false, "count": 1, "total": 1 } }

Datasets (forms)

Configuration

Endpoint: https://api.mopinion.com/...

API documentation:

x-auth-token: ...=

Postman interface

Output

 


Fields (questions)

Configuration

Endpoint: https://api.mopinion.com/...

API documentation:

x-auth-token: ...=

Postman interface

Output

 


Feedback

Configuration

Endpoint: https://api.mopinion.com/...

API documentation:

x-auth-token: ...=

Postman interface

Output


Reports

Configuration

Endpoint: https://api.mopinion.com/...

API documentation:

x-auth-token: ...=

Postman interface

Output