{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"93391833-f4f3-4d0f-a7e5-42343f84974f","name":"BI Gateway Documentation","description":"The **Retalia BI Gateway** allows third-party integrators to securely access Retalia datasets for analytical and reporting purposes.\n\nThe gateway is **read-only** and is intended solely for data retrieval.\n\n---\n\n# Authentication\n\nThe BI Gateway uses a **long-lived Personal Access Token (PAT)** for authentication.\n\nAll requests must include the token using the **Bearer authentication scheme**:\n\n```\nAuthorization: Bearer {access_token}\n\n ```\n\nPersonal access tokens are **long-lived and do not expire**. They remain valid until manually revoked by the user.\n\nFull details of the authentication process can be found in the **Authentication** section of this documentation.\n\n---\n\n# Managing Personal Access Tokens\n\nUsers can self-manage their personal access tokens within the **Retalia Portal**:\n\n1. Click your avatar (top-right corner)\n    \n2. Select **Update Details**\n    \n3. Navigate to **Personal Access Tokens**\n    \n4. Click **Create Token**\n    \n\n⚠️ **Important:**\n\nA token is only visible at the time of creation. Once the dialog is closed, the token **cannot be retrieved**. If lost, a new token must be generated.\n\n---\n\n# Pagination\n\nAs of **version 1.1**, all endpoints use query-string pagination.\n\n### Parameters\n\n| Parameter | Default | Maximum |\n| --- | --- | --- |\n| `pageSize` | 100 | 250 |\n| `page` | 1 | — |\n\n### Response Header\n\nAll paginated responses include the following header:\n\n| Header | Description |\n| --- | --- |\n| `X-TOTAL-RESULTS` | Indicates the total number of results available for the specified filter range (not just the current page). |\n\n### Example Request\n\nGET /endpoint?page=1&pageSize=100\n\n### Example Response Headers\n\n``` http\nHTTP/1.1 200 OK\nX-TOTAL-RESULTS: 1243\nContent-Type: application/json\n\n ```\n\n---\n\n# Rate Limiting\n\nAs of **version 1.1**, API requests are rate-limited to:\n\n**4 requests per second per token**\n\nIf this limit is exceeded, requests will be temporarily rejected.\n\n---\n\n# Endpoint Methods\n\nThe BI Gateway is **read-only**.\n\nOnly the following HTTP method is supported:\n\n- **GET** — Retrieve data\n    \n\n# Error Responses\n\nThe BI Gateway uses standard HTTP status codes to indicate the success or failure of a request.\n\n---\n\n## Common Status Codes\n\n### **200 — Success**\n\nThe request was successful and data has been returned.\n\n---\n\n### **400 — Bad Request**\n\nThe request could not be processed due to invalid parameters.\n\nCommon causes include:\n\n- Invalid query parameter values\n    \n- Missing required parameters\n    \n- Pagination values outside allowed limits\n    \n\n---\n\n### **401 — Unauthorized**\n\nAuthentication failed.\n\nThis occurs when:\n\n- The `Authorization` header is missing\n    \n- The token is invalid\n    \n- The token has been revoked\n    \n\nExample response:\n\n```\n{\n  \"error\": \"Unauthorized\",\n  \"message\": \"Invalid or missing access token\"\n}\n\n ```\n\n---\n\n### **429 — Too Many Requests**\n\nThe rate limit has been exceeded.\n\nAs of version 1.1, the limit is:\n\n**4 requests per second per token**\n\nClients should wait before retrying.\n\nExample response:\n\n```\n{\n  \"error\": \"RateLimitExceeded\",\n  \"message\": \"Request rate limit exceeded. Please retry later.\"\n}\n\n ```\n\n---\n\n#### **500 — Internal Server Error**\n\nAn unexpected server error occurred.\n\nThis indicates a temporary issue on the gateway side. Clients should retry after a short delay.\n\n---\n\n## Best Practices for Handling Errors\n\nIntegrators should:\n\n- Always check HTTP status codes\n    \n- Implement retry logic for **429** and **500** responses\n    \n- Log response messages for troubleshooting","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6694488","team":16285,"collectionId":"93391833-f4f3-4d0f-a7e5-42343f84974f","publishedId":"2sBXcDG1yA","public":true,"publicUrl":"https://bi-docs.retalia.cloud","privateUrl":"https://go.postman.co/documentation/6694488-93391833-f4f3-4d0f-a7e5-42343f84974f","customColor":{"top-bar":"FFFFFF","right-sidebar":"282727","highlight":"b27bfb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ea8bbfb3-0cfd-426e-a7d6-42995f0a0836/UmV0YWxpYSBMb2dvLXdoaXRlLnBuZw==","colors":{"top-bar":"282727","right-sidebar":"bc9bf0","highlight":"b27bfb"}},{"name":"light","logo":"https://content.pstmn.io/39995719-edd4-474e-b154-1aee108db89b/UmV0YWxpYSBMb2dvLUJsYWNrLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"282727","highlight":"b27bfb"}}]}},"version":"8.10.1","publishDate":"2026-02-17T15:38:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/39995719-edd4-474e-b154-1aee108db89b/UmV0YWxpYSBMb2dvLUJsYWNrLnBuZw==","logoDark":"https://content.pstmn.io/ea8bbfb3-0cfd-426e-a7d6-42995f0a0836/UmV0YWxpYSBMb2dvLXdoaXRlLnBuZw=="}},"statusCode":200},"environments":[{"name":"BI Gateway","id":"35977910-2b65-4a07-a397-d986c1ee74e2","owner":"6694488","values":[{"key":"baseUrl","value":"","enabled":true,"type":"default"},{"key":"bearerToken","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4ac86db69215e79511f011802945fe671bec2af0fcc1e71e6dce41dd07c346dd","favicon":"https://res.cloudinary.com/postman/image/upload/v1550480807/team/ovu1pv5hmc4qlsbnnlvq.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"BI Gateway","value":"6694488-35977910-2b65-4a07-a397-d986c1ee74e2"}],"canonicalUrl":"https://bi-docs.retalia.cloud/view/metadata/2sBXcDG1yA"}