{"info":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","description":"

Integration guide for BSure API v2 — Use this to connect your CRM, Power BI, or other systems to BSure survey data. You can call the API from any HTTP client; this collection is provided so you can test endpoints in Postman and use the request/response docs as a reference for your integration.

Who is this for?

Clients integrating BSure with their CRM (Salesforce, HubSpot, Zoho, etc.)
\n
Clients building reports in Power BI (or similar) from BSure responses
\n
Developers who need to pull surveys, responses, or exports into their own apps
\n

How to use this collection

As integration reference: Use the endpoint URLs, query parameters, and response examples to build your CRM connector, Power BI data source, or custom integration. All authenticated requests use Bearer token (Authorization: Bearer ).
\n
In Postman: Import the collection, set baseUrl (https://api.bsure.sa) and apiKey, then run Health Check and Get All Surveys to verify. Use the requests to explore responses and copy the same URLs/headers into your CRM or Power BI.
\n

Features

✅ Read-only GET endpoints: Surveys, Responses, Export (CSV, Excel, JSON, SPSS, Power BI)
\n
✅ Token setup and authentication guide
\n
✅ Power BI integration instructions (step-by-step)
\n
✅ Request/response examples and field descriptions for each endpoint
\n
✅ Collection-level Bearer auth; Health Check and doc-only items use no auth
\n

Quick setup (for any integration)

Get your API key: BSure → Profile → Settings → Developer tab → Create Token. Format: sp_xxxxxxxxxxxxx (32 chars).
\n
Base URL: https://api.bsure.sa
\n
Auth: Send header Authorization: Bearer on every request except Health Check.
\n
Survey ID: Use GET /v2/surveys to list surveys; use GET /v2/responses?surveyId=... or GET /v2/responses/export?surveyId=...&format=... for data.
\n

Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Folder	Purpose	Auth
Token Setup	How to get API token; Postman setup (optional)	None (docs only)
Health Check	Public health check — no auth	None
Surveys	List surveys	Bearer
Responses	List/get responses	Bearer
Export Responses	Export CSV, Excel, JSON, SPSS, Power BI	Bearer
Power BI Integration	Power BI connection guide	None (docs only)

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"51658604","collectionId":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","publishedId":"2sBXVmgoyq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-01-28T14:28:15.000Z"},"item":[{"name":"Token Setup","item":[{"name":"How to Get Your API Token","id":"70c27b29-999c-4335-9295-a5c85468841a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health","description":"

How to Get Your API Token

Step-by-Step Guide

Step 1: Log in to BSure Platform

Go to forms.bsure.sa
\n
Log in with your account credentials
\n

Step 2: Navigate to Developer Settings

Click on your Profile (usually in the top right corner)
\n
Select Settings from the dropdown menu
\n
Click on the Developer tab
\n

Step 3: Create Your API Token

In the Developer tab, you'll see the API Keys section
\n
Click the Create Token button
\n
Enter a name for your token (e.g., \"My API Key\", \"Power BI Integration\")
\n
Click Create or Generate
\n
Copy the API key
\n

Step 4: Save Your Token Securely

The API key format is: sp_xxxxxxxxxxxxx (32 characters total)
\n
Example: sp_a1b2c3d4e5f6g7h8i9j0k1l2m3
\n
Store it in a secure location (password manager, secure notes, etc.)
\n

📝 Important Notes

Token Format

Prefix: sp_
\n
Total Length: 32 characters
\n
Example: sp_a1b2c3d4e5f6g7h8i9j0k1l2m3
\n

Security Best Practices

Never share your API key with anyone
\n
Never commit API keys to version control (Git, etc.)
\n
Store keys securely (password managers, environment variables)
\n
Rotate keys regularly (revoke old ones, create new ones)
\n
Use different keys for different purposes (e.g., one for Power BI, one for testing)
\n
Monitor key usage - check when your key was last used
\n

Managing Your Keys

In the Developer tab, you can:

View all your API keys (with last 4 characters visible)
\n
See when each key was created
\n
See when each key was last used
\n
Revoke/Delete keys that are no longer needed
\n
Create new keys (maximum of 2 active keys per user)
\n

✅ Next Steps

Copy your API key from the Developer tab and store it securely.
\n
Use it in your integration:
\n
- CRM (Salesforce, HubSpot, Zoho, etc.): Configure your connector to call https://api.bsure.sa with header Authorization: Bearer .
  \n
- Power BI: See the 📊 Power BI Integration folder in this collection for step-by-step setup (Web source + Authorization header).
  \n
- Postman (optional): Set the apiKey variable in your environment and run Health Check then Get All Surveys to verify.
  \n
\n
Endpoints: Use GET /v2/surveys to list surveys; GET /v2/responses?surveyId=... for responses; GET /v2/responses/export?surveyId=...&format=csv|excel|json|spss|powerbi for exports.
\n

🆘 Troubleshooting

\"I can't find the Developer tab\"

Make sure you're logged in to forms.bsure.sa
\n
Check that you have the necessary permissions
\n
Contact support if you don't see the Developer tab
\n

\"I lost my API key\"

You cannot retrieve a lost API key
\n
Create a new one in the Developer tab
\n
Revoke the old key if you suspect it was compromised
\n

\"I can't create a new key\"

Check if you've reached the limit (2 active keys per user)
\n
Revoke an existing key first, then create a new one
\n

\"My API key doesn't work\"

Verify the key is copied correctly (no extra spaces)
\n
Check if the key is still active (not revoked)
\n
Make sure you're using the correct format: Bearer sp_xxxxxxxxxxxxx
\n

\n","urlObject":{"path":["v2","health"],"host":["https://api.bsure.sa"],"query":[],"variable":[]}},"response":[],"_postman_id":"70c27b29-999c-4335-9295-a5c85468841a"},{"name":"Setup Instructions","id":"17021d34-a5a0-42c3-a5be-2c31e4a85306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health","description":"

🔧 Using This Collection

This collection is an integration guide for connecting BSure to your CRM (Salesforce, HubSpot, Zoho, etc.), Power BI, or any other system. You can use it in Postman to test the API, or use the request/response docs as reference when building your integration.

Option A: Use in Postman (to test the API)

Step 1: Import Collection

Open Postman
Click Import and select this collection file

Step 2: Create Environment

Environments → + to create new
Name it: BSure API v2
Add variables:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Initial Value
`baseUrl`	`https://api.bsure.sa`
`apiKey`	`sp_xxxxxxxxxxxxx` (your key)
`surveyId`	(your survey ID)
`responseId`	(leave empty; auto-filled from responses)

Save and select this environment

Step 3: Get Your API Key

See \"How to Get Your API Token\" in this folder
Set apiKey in the environment to your token

Step 4: Test

Run Health Check (🏥 Health Check folder)
Run Get All Surveys (📋 Surveys folder)

Option B: Use as reference for CRM / Power BI

Base URL: https://api.bsure.sa
Auth: Header Authorization: Bearer <your_api_key>
Endpoints: See folders Surveys, Responses, Export Responses for URLs, query params, and response shapes
Power BI: See folder 📊 Power BI Integration for step-by-step connection

You don’t need Postman to integrate; use these docs to configure your CRM connector or Power BI Web source.

\n","urlObject":{"path":["v2","health"],"host":["https://api.bsure.sa"],"query":[],"variable":[]}},"response":[],"_postman_id":"17021d34-a5a0-42c3-a5be-2c31e4a85306"}],"id":"f5cecb72-865c-4e13-bac9-d21ee01d4d8c","description":"

How to get your API token. Use this token in your CRM, Power BI, or any HTTP client (Postman, curl, etc.) to authenticate with the BSure API.

\n","_postman_id":"f5cecb72-865c-4e13-bac9-d21ee01d4d8c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}},{"name":"Health Check","item":[{"name":"Health Check","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response has status field\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('status');","});","","pm.test(\"Database is connected\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.database).to.eql('connected');","});","","pm.test(\"Response time is acceptable\", function () {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"],"type":"text/javascript","id":"a953614f-cd10-452c-8d39-ae0bcf73f995"}}],"id":"5f7e96a0-5827-46fe-8aa8-607db3d23445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health","description":"

Public health check endpoint to verify API is running and database connectivity.

No authentication required

Response Body (200 OK)

{\n  \"status\": \"healthy\",\n  \"timestamp\": \"2025-12-17T10:15:00.000Z\",\n  \"service\": \"BSure API Gateway\",\n  \"version\": \"v2\",\n  \"database\": \"connected\"\n}\n

Response Fields:

status (string): Service status - \"healthy\" when all systems operational, \"degraded\" when there are issues
timestamp (string): ISO 8601 timestamp of when the health check was performed
service (string): Service name identifier
version (string): API version number
database (string): Database connectivity status - \"connected\" when database is reachable, \"disconnected\" when there are connectivity issues

\n","urlObject":{"path":["v2","health"],"host":["https://api.bsure.sa"],"query":[],"variable":[]}},"response":[{"id":"00f6f3b4-c34d-4e3d-afb5-d6da32f348ef","name":"Success - Healthy","originalRequest":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"healthy\",\n \"timestamp\": \"2025-12-17T10:15:00.000Z\",\n \"service\": \"BSure API Gateway\",\n \"version\": \"v2\",\n \"database\": \"connected\"\n}"}],"_postman_id":"5f7e96a0-5827-46fe-8aa8-607db3d23445"}],"id":"714b9e4d-0b5d-4ce5-a1f5-accc2570b3cc","description":"

Public endpoints that don't require authentication

\n","_postman_id":"714b9e4d-0b5d-4ce5-a1f5-accc2570b3cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}},{"name":"Surveys","item":[{"name":"Get All Surveys","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response has meta and data\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('meta');"," pm.expect(jsonData).to.have.property('data');"," pm.expect(jsonData.data).to.be.an('array');","});","","pm.test(\"Meta contains pagination info\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.meta).to.have.property('total');"," pm.expect(jsonData.meta).to.have.property('limit');"," pm.expect(jsonData.meta).to.have.property('offset');","});","","// Save first survey ID if available","if (pm.response.json().data && pm.response.json().data.length > 0) {"," const firstSurvey = pm.response.json().data[0];"," if (firstSurvey.surveyId && !pm.environment.get('surveyId')) {"," pm.environment.set('surveyId', firstSurvey.surveyId);"," }","}"],"type":"text/javascript","id":"21f61d8a-dcf7-4c0b-9bc6-3fc0d2645d18"}}],"id":"59676656-5bda-41a9-b86c-ed00d1a53c4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx","type":"text"}],"url":"https://api.bsure.sa/v2/surveys?includeArchived=false&limit=100&offset=0","description":"

Retrieve all surveys that the authenticated user has access to.

Query Parameters:

includeArchived (optional): Include archived surveys (default: false)
limit (optional): Max surveys to return (default: 100, max: 1000)
offset (optional): Pagination offset (default: 0)

Response Body (200 OK)

{\n  \"meta\": {\n    \"total\": 25,\n    \"limit\": 100,\n    \"offset\": 0,\n    \"returned\": 25,\n    \"includeArchived\": false\n  },\n  \"data\": [\n    {\n      \"surveyId\": \"MCvPqNklENCa80hzHk9W\",\n      \"title\": {\n        \"default\": \"Customer Satisfaction Survey\",\n        \"ar\": \"استبيان رضا العملاء\"\n      },\n      \"createdByUserDisplayName\": \"John Doe\",\n      \"createdByUserId\": \"user123\",\n      \"createdDate\": \"2025-12-01T10:00:00.000Z\",\n      \"modifiedDate\": \"2025-12-17T10:00:00.000Z\",\n      \"target\": 1000,\n      \"responsesCount\": 2451,\n      \"completedResponsesCount\": 2300,\n      \"inCompletedResponsesCount\": 151,\n      \"surveyOriginalLanguage\": \"ar\",\n      \"archived\": false\n    }\n  ]\n}\n

Response Fields:

meta (object): Pagination and summary information

total (number): Total number of surveys matching the criteria
limit (number): Maximum number of surveys requested
offset (number): Number of surveys skipped
returned (number): Actual number of surveys returned in this response
includeArchived (boolean): Whether archived surveys were included

data (array): Array of survey objects

surveyId (string): Unique identifier for the survey
title (object): Survey title in multiple languages
createdByUserDisplayName (string): Name of user who created the survey
createdByUserId (string): ID of user who created the survey
createdDate (timestamp): When the survey was created
modifiedDate (timestamp): When the survey was last modified
target (number): Target number of responses
responsesCount (number): Total number of responses received
completedResponsesCount (number): Number of completed responses
inCompletedResponsesCount (number): Number of incomplete responses
surveyOriginalLanguage (string): Original language of the survey (\"ar\" or \"en\")
archived (boolean): Whether the survey is archived

Set to 'true' to include archived surveys

\n","type":"text/plain"},"key":"includeArchived","value":"false"},{"description":{"content":"

Maximum number of surveys (1-1000)

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Number of surveys to skip for pagination

\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"745e0f49-a23a-46c3-a5df-a8fcd821502c","name":"Success - Surveys Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/surveys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"total\": 25,\n \"limit\": 100,\n \"offset\": 0,\n \"returned\": 25,\n \"includeArchived\": false\n },\n \"data\": [\n {\n \"surveyId\": \"MCvPqNklENCa80hzHk9W\",\n \"title\": {\n \"default\": \"Customer Satisfaction Survey\",\n \"ar\": \"استبيان رضا العملاء\"\n },\n \"createdByUserDisplayName\": \"John Doe\",\n \"createdByUserId\": \"user123\",\n \"createdDate\": \"2025-12-01T10:00:00.000Z\",\n \"modifiedDate\": \"2025-12-17T10:00:00.000Z\",\n \"target\": 1000,\n \"responsesCount\": 2451,\n \"completedResponsesCount\": 2300,\n \"inCompletedResponsesCount\": 151,\n \"surveyOriginalLanguage\": \"ar\",\n \"archived\": false\n }\n ]\n}"}],"_postman_id":"59676656-5bda-41a9-b86c-ed00d1a53c4b"},{"name":"Get All Surveys (With Archived)","id":"a56cc820-b836-4d70-8c69-f8ce36e92aea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/surveys?includeArchived=true&limit=100","description":"

Retrieve all surveys including archived ones. Uses same response shape as Get All Surveys; set includeArchived=true to include archived surveys in the list.

Include archived surveys

\n","type":"text/plain"},"key":"includeArchived","value":"true"},{"description":{"content":"

Max surveys to return (1-1000)

\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[],"_postman_id":"a56cc820-b836-4d70-8c69-f8ce36e92aea"}],"id":"a8213c82-8138-419b-a411-bde8e6f8ece7","description":"

Endpoints for managing surveys

\n","_postman_id":"a8213c82-8138-419b-a411-bde8e6f8ece7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}},{"name":"Responses","item":[{"name":"Get All Responses","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response has meta and data\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('meta');"," pm.expect(jsonData).to.have.property('data');"," pm.expect(jsonData.data).to.be.an('array');","});","","pm.test(\"Rate limit headers present\", function () {"," pm.expect(pm.response.headers.get('X-RateLimit-Limit')).to.exist;"," pm.expect(pm.response.headers.get('X-RateLimit-Remaining')).to.exist;"," pm.expect(pm.response.headers.get('X-RateLimit-Reset')).to.exist;","});","","// Save first response ID if available","if (pm.response.json().data && pm.response.json().data.length > 0) {"," const firstResponse = pm.response.json().data[0];"," if (firstResponse.response_id) {"," pm.environment.set('responseId', firstResponse.response_id);"," }","}"],"type":"text/javascript","id":"bcb330df-d4e5-43cb-944b-159d01735051"}}],"id":"b9cbe85d-740a-408c-bf04-bf54feceada3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx","type":"text"}],"url":"https://api.bsure.sa/v2/responses?surveyId=MCvPqNklENCa80hzHk9W&includeSchema=false","description":"

Retrieve all responses for a specific survey.

Query Parameters:

surveyId (required): Survey ID
includeSchema (optional): Include question schema (default: false)

Response Body (200 OK)

{\n  \"meta\": {\n    \"survey_id\": \"MCvPqNklENCa80hzHk9W\",\n    \"total_responses\": 2451\n  },\n  \"data\": [\n    {\n      \"response_id\": \"1VaAmEAwWjC24g1cdIkP\",\n      \"at\": \"2025-12-17T10:15:00.000Z\",\n      \"context\": {\n        \"status\": \"completed\",\n        \"start_time\": \"2025-12-17T10:10:00.000Z\",\n        \"end_time\": \"2025-12-17T10:15:00.000Z\",\n        \"duration_seconds\": 300,\n        \"location\": {\n          \"lat\": 24.7136,\n          \"lng\": 46.6753\n        },\n        \"lang\": \"ar\"\n      },\n      \"answers\": {\n        \"Q1\": \"مرحبً من الـAPI\",\n        \"Q2\": \"#ff0000\",\n        \"Q29\": {\n          \"R1\": \"1\",\n          \"R2\": \"1\"\n        }\n      }\n    }\n  ]\n}\n

Response Fields:

meta (object): Metadata about the response set

survey_id (string): The survey ID these responses belong to
total_responses (number): Total number of responses returned

data (array): Array of response objects

response_id (string): Unique identifier for the response
at (string): ISO 8601 timestamp when the response was submitted
context (object): Response metadata
- status (string): Response status - \"completed\" or \"incompleted\"
- start_time (string): When the interview started (ISO 8601)
- end_time (string): When the interview ended (ISO 8601)
- duration_seconds (number): Total duration in seconds
- location (object|null): GPS coordinates if available
  - lat (number): Latitude
  - lng (number): Longitude
  \n
- lang (string): Language code (\"ar\" or \"en\")
\n
answers (object): Question answers keyed by question ID
- Keys are question IDs (e.g., \"Q1\", \"Q2\")
- Values are answer values (strings, numbers, arrays, or objects)
- Matrix questions are returned as structured objects
\n

schema (object, optional): Question schema definitions (only if includeSchema=true)

Keys are question IDs
Values contain question metadata (label, type, required, etc.)

Survey ID to fetch responses for

\n","type":"text/plain"},"key":"surveyId","value":"MCvPqNklENCa80hzHk9W"},{"description":{"content":"

Set to 'true' to include question schema definitions

\n","type":"text/plain"},"key":"includeSchema","value":"false"}],"variable":[]}},"response":[{"id":"19cf698c-6827-4c10-ae56-90afb9f5d14d","name":"Success - With Responses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/responses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"survey_id\": \"MCvPqNklENCa80hzHk9W\",\n \"total_responses\": 2451\n },\n \"data\": [\n {\n \"response_id\": \"1VaAmEAwWjC24g1cdIkP\",\n \"at\": \"2025-12-17T10:15:00.000Z\",\n \"context\": {\n \"status\": \"completed\",\n \"start_time\": \"2025-12-17T10:10:00.000Z\",\n \"end_time\": \"2025-12-17T10:15:00.000Z\",\n \"duration_seconds\": 300,\n \"location\": {\n \"lat\": 24.7136,\n \"lng\": 46.6753\n },\n \"lang\": \"ar\"\n },\n \"answers\": {\n \"Q1\": \"مرحبً من الـAPI\",\n \"Q2\": \"#ff0000\",\n \"Q29\": {\n \"R1\": \"1\",\n \"R2\": \"1\"\n }\n }\n }\n ]\n}"}],"_postman_id":"b9cbe85d-740a-408c-bf04-bf54feceada3"},{"name":"Get All Responses (With Schema)","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response includes schema\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('schema');","});"],"type":"text/javascript","id":"c8713af7-c4d6-4a25-b84a-41e1bf2e25f5"}}],"id":"8c77de32-cbe8-4ac9-83e1-c072183c1f7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx","type":"text"}],"url":"https://api.bsure.sa/v2/responses?surveyId=MCvPqNklENCa80hzHk9W&includeSchema=true","description":"

Get all responses with question schema definitions included.

Response Body (200 OK)

Same as \"Get All Responses\" but includes schema field:

{\n  \"meta\": { ... },\n  \"schema\": {\n    \"Q1\": {\n      \"label\": \"نص\",\n      \"type\": \"text\",\n      \"required\": true\n    },\n    \"Q29\": {\n      \"label\": \"مصفوفة اختيار واحد\",\n      \"type\": \"matrix_parent\",\n      \"required\": true,\n      \"config\": {\n        \"rows\": { \"R1\": \"R1\", \"R2\": \"R2\" },\n        \"cols\": { \"C1\": \"C1\", \"C2\": \"C2\" }\n      },\n      \"cells\": [\"Q29_R1\", \"Q29_R2\"]\n    }\n  },\n  \"data\": [ ... ]\n}\n

Schema Fields:

label (string): Question label in survey language
type (string): Question type (\"text\", \"matrix_parent\", \"radio\", etc.)
required (boolean): Whether the question is required
config (object, optional): Configuration for complex question types
cells (array, optional): Sub-question IDs for matrix questions

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}},"urlObject":{"path":["v2","responses"],"host":["https://api.bsure.sa"],"query":[{"key":"surveyId","value":"MCvPqNklENCa80hzHk9W"},{"key":"includeSchema","value":"true"}],"variable":[]}},"response":[{"id":"bbe5deab-5a4f-4c5d-b78e-0b599c41b45b","name":"Success - With Schema","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/responses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"survey_id\": \"MCvPqNklENCa80hzHk9W\",\n \"total_responses\": 2451\n },\n \"schema\": {\n \"Q1\": {\n \"label\": \"نص\",\n \"type\": \"text\",\n \"required\": true\n },\n \"Q29\": {\n \"label\": \"مصفوفة اختيار واحد\",\n \"type\": \"matrix_parent\",\n \"required\": true,\n \"config\": {\n \"rows\": { \"R1\": \"R1\", \"R2\": \"R2\" },\n \"cols\": { \"C1\": \"C1\", \"C2\": \"C2\" }\n },\n \"cells\": [\"Q29_R1\", \"Q29_R2\"]\n }\n },\n \"data\": [\n {\n \"response_id\": \"1VaAmEAwWjC24g1cdIkP\",\n \"at\": \"2025-12-17T10:15:00.000Z\",\n \"context\": { ... },\n \"answers\": { ... }\n }\n ]\n}"}],"_postman_id":"8c77de32-cbe8-4ac9-83e1-c072183c1f7c"},{"name":"Get Single Response","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response data is object (not array)\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.data).to.be.an('object');"," pm.expect(jsonData.meta.total_responses).to.eql(1);","});"],"type":"text/javascript","id":"a1ad758f-e07a-44ea-ac39-9d51202fac60"}}],"id":"8112ae40-9436-48bf-b1b7-79a859dbd142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx","type":"text"}],"url":"https://api.bsure.sa/v2/responses/?includeSchema=true","description":"

Retrieve a specific response by its ID.

Route Parameters:

responseId: The response ID

Query Parameters:

includeSchema (optional): Include question schema

Response Body (200 OK)

{\n  \"meta\": {\n    \"survey_id\": \"MCvPqNklENCa80hzHk9W\",\n    \"total_responses\": 1\n  },\n  \"schema\": { ... },\n  \"data\": {\n    \"response_id\": \"1VaAmEAwWjC24g1cdIkP\",\n    \"at\": \"2025-12-17T10:15:00.000Z\",\n    \"context\": {\n      \"status\": \"completed\",\n      \"start_time\": \"2025-12-17T10:10:00.000Z\",\n      \"end_time\": \"2025-12-17T10:15:00.000Z\",\n      \"duration_seconds\": 300,\n      \"location\": {\n        \"lat\": 24.7136,\n        \"lng\": 46.6753\n      },\n      \"lang\": \"ar\"\n    },\n    \"answers\": {\n      \"Q1\": \"مرحبً من الـAPI\",\n      \"Q29\": {\n        \"R1\": \"1\",\n        \"R2\": \"1\"\n      }\n    }\n  }\n}\n

Response Fields:

meta (object): Metadata

survey_id (string): Survey ID
total_responses (number): Always 1 for single response

data (object): Single response object (not array)

Same structure as items in \"Get All Responses\" array
response_id, at, context, answers fields

schema (object, optional): Question schema (if includeSchema=true)

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}},"urlObject":{"path":["v2","responses",""],"host":["https://api.bsure.sa"],"query":[{"key":"includeSchema","value":"true"}],"variable":[]}},"response":[{"id":"b1927d04-f6da-44cb-9baf-b00d6b76b97e","name":"Success - Single Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/responses/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"survey_id\": \"MCvPqNklENCa80hzHk9W\",\n \"total_responses\": 1\n },\n \"schema\": {\n \"Q1\": {\n \"label\": \"نص\",\n \"type\": \"text\",\n \"required\": true\n }\n },\n \"data\": {\n \"response_id\": \"1VaAmEAwWjC24g1cdIkP\",\n \"at\": \"2025-12-17T10:15:00.000Z\",\n \"context\": {\n \"status\": \"completed\",\n \"start_time\": \"2025-12-17T10:10:00.000Z\",\n \"end_time\": \"2025-12-17T10:15:00.000Z\",\n \"duration_seconds\": 300,\n \"location\": {\n \"lat\": 24.7136,\n \"lng\": 46.6753\n },\n \"lang\": \"ar\"\n },\n \"answers\": {\n \"Q1\": \"مرحبً من الـAPI\",\n \"Q29\": {\n \"R1\": \"1\",\n \"R2\": \"1\"\n }\n }\n }\n}"},{"id":"ba672936-a47b-4be4-b861-6fab3e37e25e","name":"Error - Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/responses/non-existent-id"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Response not found\"\n }\n}"}],"_postman_id":"8112ae40-9436-48bf-b1b7-79a859dbd142"}],"id":"7e5091b3-d982-417f-8586-62ede7a9c64c","description":"

Endpoints for retrieving survey responses

\n","_postman_id":"7e5091b3-d982-417f-8586-62ede7a9c64c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}},{"name":"Export Responses","item":[{"name":"Export - CSV","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Response has url and format\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property('url');"," pm.expect(j).to.have.property('format', 'csv');"," pm.expect(j).to.have.property('surveyId');"," pm.expect(j).to.have.property('count');","});"],"type":"text/javascript","id":"c3f1cf96-e1e3-4881-8c32-a13d17bc98e6"}}],"id":"4fb4e689-d52e-4f78-a414-fa64a978ff96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx","type":"text"}],"url":"https://api.bsure.sa/v2/responses/export?surveyId=MCvPqNklENCa80hzHk9W&format=csv","description":"

Export responses in CSV format. Returns download URL.

Response Body (200 OK)

{\n  \"url\": \"https://storage.googleapis.com/bucket-name/exports/Survey_Title_1734432000000.csv\",\n  \"format\": \"csv\",\n  \"surveyId\": \"MCvPqNklENCa80hzHk9W\",\n  \"count\": 2451,\n  \"expiresIn\": \"1 hour\"\n}\n

Response Fields:

url (string): Public download URL - Use this URL to download the file
format (string): Export format (\"csv\", \"excel\", \"json\", \"spss\", \"powerbi\")
surveyId (string): Survey ID that was exported
count (number): Number of responses in the export
expiresIn (string): How long the URL is valid (typically \"1 hour\")

Note: The download URL expires after 1 hour. Download the file immediately after receiving the response.

Export format

\n","type":"text/plain"},"key":"format","value":"csv"}],"variable":[]}},"response":[{"id":"e3ef3a50-1343-433d-bac6-d1a9665095dd","name":"Success - Export URL","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer sp_xxxxxxxxxxxxx"}],"url":"https://api.bsure.sa/v2/responses/export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://storage.googleapis.com/bucket-name/exports/Survey_Title_1734432000000.csv\",\n \"format\": \"csv\",\n \"surveyId\": \"MCvPqNklENCa80hzHk9W\",\n \"count\": 2451,\n \"expiresIn\": \"1 hour\"\n}"}],"_postman_id":"4fb4e689-d52e-4f78-a414-fa64a978ff96"},{"name":"Export - Excel","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Response has url and format\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property('url');"," pm.expect(j).to.have.property('format', 'excel');"," pm.expect(j).to.have.property('surveyId');"," pm.expect(j).to.have.property('count');","});"],"type":"text/javascript","id":"e32a5ee9-ec3c-4c11-acc8-f8a15a586541"}}],"id":"d8968631-7621-4bd9-863a-db95c10d7a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/responses/export?surveyId=MCvPqNklENCa80hzHk9W&format=excel","description":"

Export responses in Excel (.xlsx) format. Returns a download URL (expires in 1 hour). Same response shape as Export - CSV.

Export format: excel

\n","type":"text/plain"},"key":"format","value":"excel"}],"variable":[]}},"response":[],"_postman_id":"d8968631-7621-4bd9-863a-db95c10d7a38"},{"name":"Export - JSON","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Response has url and format\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property('url');"," pm.expect(j).to.have.property('format', 'json');"," pm.expect(j).to.have.property('surveyId');"," pm.expect(j).to.have.property('count');","});"],"type":"text/javascript","id":"c6aecc4b-75f4-4b80-91cc-6405c0104004"}}],"id":"f2be3702-b02b-4178-b40e-ec83d93f9b5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/responses/export?surveyId=MCvPqNklENCa80hzHk9W&format=json","description":"

Export responses in JSON format. Returns a download URL (expires in 1 hour). Same response shape as Export - CSV.

Export format: json

\n","type":"text/plain"},"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"f2be3702-b02b-4178-b40e-ec83d93f9b5f"},{"name":"Export - SPSS","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Response has url and format\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property('url');"," pm.expect(j).to.have.property('format', 'spss');"," pm.expect(j).to.have.property('surveyId');"," pm.expect(j).to.have.property('count');","});"],"type":"text/javascript","id":"693981f6-b314-4238-a1d8-d87d67b67922"}}],"id":"d3d363dd-21d8-4c24-90ee-094705c43798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/responses/export?surveyId=MCvPqNklENCa80hzHk9W&format=spss","description":"

Export responses in SPSS (.sav) format. Returns a download URL (expires in 1 hour). Same response shape as Export - CSV.

Export format: spss (.sav)

\n","type":"text/plain"},"key":"format","value":"spss"}],"variable":[]}},"response":[],"_postman_id":"d3d363dd-21d8-4c24-90ee-094705c43798"},{"name":"Export - Power BI","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });","pm.test(\"Response has url and format\", function () {"," var j = pm.response.json();"," pm.expect(j).to.have.property('url');"," pm.expect(j).to.have.property('format', 'powerbi');"," pm.expect(j).to.have.property('surveyId');"," pm.expect(j).to.have.property('count');","});"],"type":"text/javascript","id":"f9d8cf36-6559-42f9-8c00-9fee5ffeb099"}}],"id":"28276837-46f3-4569-80b8-ce834de7c865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.bsure.sa/v2/responses/export?surveyId=MCvPqNklENCa80hzHk9W&format=powerbi","description":"

Export responses optimized for Power BI import.

Response Body (200 OK)

{\n  \"url\": \"https://storage.googleapis.com/bucket-name/exports/Survey_Title_1734432000000.powerbi.json\",\n  \"format\": \"powerbi\",\n  \"surveyId\": \"MCvPqNklENCa80hzHk9W\",\n  \"count\": 2451,\n  \"expiresIn\": \"1 hour\"\n}\n

Note: This format is specifically optimized for Power BI data import. See Power BI Integration section for detailed setup instructions.

Export survey responses in various formats

\n","_postman_id":"6c355967-fdb0-499d-93ea-cfa74dd55068","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}},{"name":"Power BI Integration","item":[{"name":"How to Connect Power BI to BSure API","id":"52a5b692-5d22-4d80-8bfe-6779980d38d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health","description":"

How to Connect Power BI to BSure API

Prerequisites

Before you begin, make sure you have:

API Key - Get it from forms.bsure.sa > Profile Settings > Developer Tab > Create Token
\n
Survey ID - Use the \"Get All Surveys\" endpoint to find your survey ID
\n
Power BI Desktop - Installed and ready to use
\n

Step-by-Step Connection Guide

Step 1: Get Your API Key

Go to forms.bsure.sa
\n
Navigate to Profile > Settings > Developer tab
\n
Click Create Token
\n
Copy your API key (format: sp_xxxxxxxxxxxxx)
\n
Save it securely - you'll need it in the next steps
\n

Step 2: Get Your Survey ID

Use the \"Get All Surveys\" endpoint in this Postman collection
\n
Copy the surveyId from the response
\n
Example: MCvPqNklENCa80hzHk9W
\n

Step 3: Open Power BI Desktop

Launch Power BI Desktop
\n
Click Get Data button (Home ribbon)
\n
Select Web from the data sources list
\n
Click Connect
\n

Step 4: Configure Advanced Web Source

In the From Web dialog:
\n
- Select \"Advanced\" option (radio button at the top)
  \n
- You'll see two sections: URL parts and HTTP request header parameters
  \n
\n

Configure URL Parts:

In the URL parts section, enter your API endpoint:

                    https://api.bsure.sa/v2/responses?surveyId=YOUR_SURVEY_ID\n\n

Replace YOUR_SURVEY_ID with your actual survey ID
\n

Example:

                    https://api.bsure.sa/v2/responses?surveyId=MCvPqNklENCa80hzHk9W\n\n

The URL preview will show your complete URL
\n

Configure HTTP Request Header:
\n
- In the HTTP request header parameters section:
  \n
- Header Name (dropdown): Select \"Authorization\" from the dropdown
  \n
\n

    sp_xxxxxxxxxxxxx\n

Replace sp_xxxxxxxxxxxxx with your actual API key
Important: Include the word \"Bearer\" followed by a space, then your API key
Example: Bearer sp_a1b2c3d4e5f6g7h8i9j0k1l2m3

```

Optional Settings:
\n
- Command timeout: Leave empty (uses default) or set if needed
\n
Click OK
\n

Step 5: Access Web Content Dialog

After clicking OK, you'll see the Access Web content dialog
\n
Select Anonymous (since authentication is handled via headers)
\n
Click Connect
\n

Step 6: Transform Data

Power BI will fetch and display the JSON response
\n
You'll see a preview of the data structure
\n
Click Transform Data to open Power Query Editor
\n
- Or click Load to import directly (you can transform later)
\n
In Power Query Editor:
\n
- Expand the data column (click the expand icon ↗)
  \n
- Select which columns to expand:
  \n
  - ✅ response_id
    \n
  - ✅ at
    \n
  - ✅ context
    \n
  - ✅ answers
    \n
  \n
- Uncheck \"Use original column name as prefix\" (optional)
  \n
- Click OK
  \n
\n
Expand nested columns:
\n
- Expand context column to get: status, start_time, end_time, duration_seconds, location, lang
  \n
- Expand answers column to get all question responses (Q1, Q2, etc.)
  \n
\n
Set data types:
\n
- Change at, start_time, end_time to Date/Time
  \n
- Set numeric columns to Number type
  \n
\n
Click Close & Apply when done
\n

Visual Guide Reference

When you see the From Web dialog:

✅ Select \"Advanced\" (not Basic)
\n
✅ Enter URL in URL parts section
\n
✅ In HTTP request header parameters:
\n
- Header Name: Authorization (from dropdown)
  \n
- Header Value: Bearer sp_xxxxxxxxxxxxx (your API key with \"Bearer \" prefix)
  \n
\n
✅ Click OK
\n

Alternative: Using Power BI Export Format

If you prefer a pre-formatted export:

Use the \"Export - Power BI\" endpoint in Postman
\n
Copy the url from the response
\n
In Power BI Desktop:
\n
- Get Data > Web
  \n
- Enter the export URL
  \n
- Click OK
  \n
- Select Anonymous authentication
  \n
- Click Connect
  \n
\n

Note: Export URLs expire after 1 hour. For scheduled refreshes, use the direct API connection method above.

Power BI Settings for Scheduled Refresh

Configure Data Source Credentials

Go to File > Options and Settings > Data Source Settings
\n
Select your BSure API data source
\n
Click Edit Permissions
\n
Set authentication:
\n
- Authentication method: Anonymous (headers handle auth)
  \n
- Or use Basic with:
  \n
  - Username: (empty)
    \n
  - Password: Your API key
    \n
  \n
\n
Click OK
\n

Enable Scheduled Refresh (Power BI Service)

Publish your report:
\n
- File > Publish > Publish to Power BI
  \n
- Sign in and select workspace
  \n
- Click Publish
  \n
\n
Configure in Power BI Service:
\n
- Go to app.powerbi.com
  \n
- Navigate to your workspace
  \n
- Click Datasets tab
  \n
- Find your dataset
  \n
- Click ... (more options) > Settings
  \n
\n
Set Data Source Credentials:
\n
- Expand Data source credentials
  \n
- Click Edit credentials
  \n
- Authentication method: Anonymous
  \n
- Click Sign in
  \n
\n
Enable Scheduled Refresh:
\n
- Go to Scheduled refresh section
  \n
- Toggle Keep your data up to date ON
  \n
- Set Refresh frequency: Daily (or as needed)
  \n
- Set Time zone
  \n
- Click Apply
  \n
\n

Troubleshooting

Error: \"Unable to connect\"

✅ Check API key is correct
\n
✅ Verify URL is correct
\n
✅ Ensure survey ID exists and you have access
\n
✅ Check internet connection
\n

Error: \"401 Unauthorized\"

✅ Verify API key format: sp_xxxxxxxxxxxxx
\n
✅ Check API key is active (not revoked in Developer tab)
\n
✅ Ensure no extra spaces in the header value
\n

Error: \"404 Not Found\"

✅ Verify survey ID is correct
\n
✅ Check you have access to the survey
\n
✅ Test the endpoint in Postman first
\n

Data Not Refreshing

✅ Check credentials in Data Source Settings
\n
✅ Verify scheduled refresh is enabled
\n
✅ Check refresh history for errors
\n
✅ Ensure API key hasn't been revoked
\n

URL Preview Shows Incorrect URL

✅ Check URL parts field has correct endpoint
\n
✅ Verify survey ID parameter is included
\n
✅ Make sure URL starts with https://
\n

Security Best Practices

Never hardcode API keys in Power BI reports
\n
Use Power BI Service credentials for scheduled refreshes
\n
Rotate API keys regularly
\n
Monitor API usage in Developer tab
\n
Use separate API keys for different purposes
\n
Revoke unused keys immediately
\n

Additional Resources

Power BI Documentation: Get data from web
\n
Power BI Advanced Options: Advanced web connector options
\n
BSure API Documentation: See other endpoints in this collection
\n

\n","urlObject":{"path":["v2","health"],"host":["https://api.bsure.sa"],"query":[],"variable":[]}},"response":[],"_postman_id":"52a5b692-5d22-4d80-8bfe-6779980d38d6"},{"name":"Step-by-Step: Power BI Setup","id":"b8caf96b-a284-4101-b2be-842471705f48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.bsure.sa/v2/health","description":"

Step-by-Step: Power BI Setup Guide

Quick Start (5 Minutes)

1. Get Your Credentials

API Key: Get from forms.bsure.sa > Profile Settings > Developer Tab > Create Token
\n
Survey ID: Use \"Get All Surveys\" endpoint in Postman to find your survey ID
\n
Base URL: https://api.bsure.sa
\n

2. Open Power BI Desktop

Launch Power BI Desktop
\n
Click Get Data button (Home tab)
\n
Select Web from the data sources list
\n
Click Connect
\n

3. Configure Advanced Web Source

In the From Web dialog:

Select \"Advanced\" option (radio button at the top - NOT Basic)
\n
URL Parts Section:
\n
- Enter your complete API endpoint URL:
  \n
```
          https://api.bsure.sa/v2/responses?surveyId=YOUR_SURVEY_ID\n\n
```
- Replace YOUR_SURVEY_ID with your actual survey ID
  \n
- Example:
  \n
```
          https://api.bsure.sa/v2/responses?surveyId=MCvPqNklENCa80hzHk9W\n\n
```
- The URL preview below will show your complete URL
  \n
\n
HTTP Request Header Parameters Section:
\n
- Header Name (dropdown): Select \"Authorization\" from the dropdown menu
  \n
- Header Value (input field): Enter:
  \n
```
          sp_xxxxxxxxxxxxx\n\n
```
  - Replace sp_xxxxxxxxxxxxx with your actual API key
    \n
  - Important: Must include \"Bearer \" (with space) before your API key
    \n
  - Example: Bearer sp_a1b2c3d4e5f6g7h8i9j0k1l2m3
    \n
  \n
\n
Command Timeout: Leave empty (uses default)
\n
Click OK
\n

4. Access Web Content Dialog

After clicking OK, you'll see Access Web content dialog
\n
Select Anonymous (authentication is handled via headers)
\n
Click Connect
\n

5. Transform Data

Power BI will fetch the JSON response
\n
Click Transform Data to open Power Query Editor
\n
- Or click Load to import directly
\n
In Power Query Editor:
\n
- Expand the data column (click expand icon ↗)
  \n
- Select columns: response_id, at, context, answers
  \n
- Click OK
  \n
- Expand context column for metadata
  \n
- Expand answers column for question responses
  \n
- Set date columns to Date/Time type
  \n
- Click Close & Apply
  \n
\n

Visual Configuration Reference

When you see the From Web dialog, configure it exactly like this:

Mode Selection:

✅ Advanced (selected)
\n
❌ Basic (not selected)
\n

URL Parts:

https://api.bsure.sa/v2/responses?surveyId=YOUR_SURVEY_ID\n\n

HTTP Request Header Parameters:

Header Name: Authorization (from dropdown)
\n
Header Value: Bearer sp_xxxxxxxxxxxxx (your API key with \"Bearer \" prefix)
\n

URL Preview:

Should show your complete URL with survey ID

Command Timeout:

Leave empty

Data Transformation Steps

Step 1: Expand Data Column

In Power Query Editor, find the data column
\n
Click the expand icon (↗) next to column name
\n
Select columns:
\n
- ✅ response_id
  \n
- ✅ at
  \n
- ✅ context
  \n
- ✅ answers
  \n
\n
Uncheck \"Use original column name as prefix\"
\n
Click OK
\n

Step 2: Expand Context Column

Click expand icon on context column
\n
Select:
\n
- ✅ status
  \n
- ✅ start_time
  \n
- ✅ end_time
  \n
- ✅ duration_seconds
  \n
- ✅ location
  \n
- ✅ lang
  \n
\n
Click OK
\n

Step 3: Expand Answers Column

Click expand icon on answers column
\n
Select all question columns (Q1, Q2, Q3, etc.)
\n
Click OK
\n

Step 4: Set Data Types

Select at column
\n
Right-click > Change Type > Date/Time
\n
Repeat for start_time and end_time
\n
Set numeric columns to Number type
\n
Set text columns to Text type
\n

Step 5: Close & Apply

Click Close & Apply
\n
Data will load into Power BI
\n

Scheduled Refresh Setup (Power BI Service)

1. Publish Report

File > Publish > Publish to Power BI
\n
Sign in and select workspace
\n
Click Publish
\n

2. Configure Data Source

Go to app.powerbi.com
\n
Navigate to your workspace
\n
Click Datasets tab
\n
Find your dataset
\n
Click ... (more options) > Settings
\n

3. Set Credentials

Expand Data source credentials
\n
Click Edit credentials
\n
Authentication method: Anonymous
\n
Click Sign in
\n

4. Enable Scheduled Refresh

Go to Scheduled refresh section
\n
Toggle Keep your data up to date ON
\n
Set Refresh frequency: Daily (or as needed)
\n
Set Time zone
\n
Click Apply
\n

Testing Your Connection

Test in Power Query Editor

Click Home > Advanced Editor
\n
Review the M query
\n
Click Done
\n
Click Refresh Preview (right side)
\n
Verify data loads correctly
\n

Test Scheduled Refresh

After publishing to Power BI Service
\n
Wait for scheduled refresh time
\n
Check Refresh history in dataset settings
\n
Verify Last refresh timestamp
\n
Check for any errors
\n

Common Issues & Solutions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Issue	Solution
\"401 Unauthorized\"	Check API key format: `Bearer sp_xxx` (with space after Bearer)
\"404 Not Found\"	Verify survey ID is correct in URL
Data not refreshing	Check scheduled refresh is enabled in Power BI Service
URL preview incorrect	Verify URL parts field has complete URL with surveyId parameter
Header not working	Ensure \"Authorization\" is selected from dropdown, value is `Bearer sp_xxx`
Missing columns	Expand nested columns in Power Query Editor
Date format issues	Change column type to Date/Time in Power Query

✅ Checklist

API key obtained from forms.bsure.sa Developer tab
\n
Survey ID identified from Get All Surveys endpoint
\n
Power BI Desktop installed
\n
Advanced mode selected in From Web dialog
\n
URL entered correctly in URL parts section
\n
Authorization header configured (Header Name: Authorization, Value: Bearer sp_xxx)
\n
Anonymous authentication selected in Access Web content dialog
\n
Data loaded successfully
\n
Columns expanded and formatted in Power Query
\n
Report published to Power BI Service
\n
Scheduled refresh configured
\n
Refresh tested and working
\n

🎉 You're Done!

Your Power BI report is now connected to BSure API and will automatically refresh with the latest survey responses!

\n","urlObject":{"path":["v2","health"],"host":["https://api.bsure.sa"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8caf96b-a284-4101-b2be-842471705f48"}],"id":"096e5163-c7bf-4204-8933-5502b6b76adf","description":"

Step-by-step guide for connecting Power BI (or similar tools) to the BSure API. Use this folder together with the Export and Responses endpoints to build reports from your survey data.

\n","_postman_id":"096e5163-c7bf-4204-8933-5502b6b76adf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]},"isInherited":true,"source":{"_postman_id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","id":"2de804e6-d70c-4e4f-9d9b-0e9a67b10cc1","name":"BSure API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"sp_xxxxxxxxxxxxx"}]}},"variable":[{"key":"baseUrl","value":"https://api.bsure.sa","type":"string"},{"key":"apiKey","value":"sp_xxxxxxxxxxxxx","type":"string"},{"key":"surveyId","value":"MCvPqNklENCa80hzHk9W","type":"string"},{"key":"responseId","value":"","type":"string"}]}