{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3d1e8ad7-415d-4027-8b81-9c93e06ccbd7","name":"Admedia - API Documentation","description":"# ClearTrust Overview API – Publisher ID Threat Summary\n\n_  \n_Endpoint -_\n\nGET /api/apigw.php\n\n_\n\n_Base URL -_\n\n[https://rapidapi.cleartrust.app<br>](https://rapidapi.cleartrust.app)\n\n_Description_ _**\\-**_\n\n**Returns an overview of traffic classified by Threat Category, Threat Type and Threat Code** filtered by a specific **Publisher ID**, within a given date range.\n\nThis API aggregates threat categories events such as **Bots, Spam, Proxy, Brand Safety**, etc., Threat Types such as **High Risk, Medium Risk and Low Risks** and Threat Code such as **Proxy Servers, Trojan** etc for a specific Publisher ID for reporting and analytics.\n\n_\n\n_Request URL (Success) -_\n\n``` antlr4\nhttps://rapidapi.cleartrust.app/api/apigw.php?bizid=<BIZID>&sdate=YYYY-M-DD&edate=YYYY-MM-DD&apicode=OVERVIEW&repid=93&PUBLISHERID=<FILTERED_PUB_ID>&dims=DIM1,DIM2&per_page=10000&shortcode=<SHORTCODE>&token=<TOKEN>\n\n ```\n\n_\n\n_Query Parameters -_\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `bizid` | Integer | ✅ Yes | Business identifier |\n| `sdate` | Date (YYYY-MM-DD) | ✅ Yes | Start date |\n| `edate` | Date (YYYY-MM-DD) | ✅ Yes | End date |\n| `apicode` | String | ✅ Yes | API operation code (`OVERVIEW`) |\n| `repid` | Integer | ✅ Yes | Report ID (fixed to - 93) |\n| `PUBLISHERID` | Integer | ✅ Yes | Publisher to filter results |\n| `dims` | String | ✅ Yes | Grouping dimensions (`PUBLISHERID, Threat Category,Threat Type`) |\n| `per_page` | Integer | ❌ Optional | Max records per response |\n| `shortcode` | String | ✅ Yes | Client shortcode |\n| `token` | String | ✅ Yes | Authentication token |\n\n_\n\n_Response Format -_\n\nContent-Type: `application/json`Successful Response (200 OK)\n\n``` bash\n{\n  \"status\": \"success\",\n  \"message\": {\n    \"data\": {\n      \"<shortcode>\": {\n        \"107415\": {\n          \"Bots\": 42193,\n          \"Clean\": 23542,\n          \"Spam\": 2370,\n          \"Proxy\": 2,\n          \"Brand Safety\": 2\n        }\n      }\n    }\n  }\n}\n\n ```\n\n_\n\n_Response Field Explanation -_\n\n1. **status** **\\-** Request execution status\n    \n2. **data** - Aggregated results\n    \n3. **shortcode** **\\-** Client Shortcode\n    \n4. **107415** - Publisher ID\n    \n5. **Bots,Spam, etc.** - Threat category counts\n    \n6. **bizid**, **shortcode** and **token** are hardcoded values.\n    \n\n_\n\n_Important Notes -_\n\n1. `PUBLISHERID` acts as a **filter**, not just a grouping key.\n    \n2. When passing multiple values in `dims`, use a comma-separated list.\n    \n3. Environment **report_param_value** should be loaded to run the API.\n    \n4. Business ID (bizid), shortcode and token are hardcoded values and is fixed.\n    \n5. Date range size affects response time and payload size. Try to fire the API for a month only.\n    \n6. Each request must include your assigned `bizid`, `shortcode`, and `token`. These are mandatory fields and should be passed while testing locally.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"44157508","team":4103749,"collectionId":"3d1e8ad7-415d-4027-8b81-9c93e06ccbd7","publishedId":"2sBXVfkCMA","public":true,"publicUrl":"https://admediadocs.cleartrust.app","privateUrl":"https://go.postman.co/documentation/44157508-3d1e8ad7-415d-4027-8b81-9c93e06ccbd7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-01-13T10:25:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"report_param_value","id":"810612f0-ef5c-4e04-8dad-3c04f40e29e8","owner":"44157508","values":[{"key":"bizid","value":"","enabled":true,"type":"default"},{"key":"token","value":"","enabled":true,"type":"default"},{"key":"shortcode","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/2d587c25714f2a16b567acd0f260e9b64de1ebed45b3a729461d7a736c28a2fa","favicon":"https://cleartrust.app/favicon.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":"report_param_value","value":"44157508-810612f0-ef5c-4e04-8dad-3c04f40e29e8"}],"canonicalUrl":"https://admediadocs.cleartrust.app/view/metadata/2sBXVfkCMA"}