{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f93481f9-4dc5-4835-ab74-3299ef6b227f","name":"Horizm Connect API","description":"Welcome to Horizm Connect API documentation. Here you can find everything you need to get started for being authenticated and make requests against our API.\n\n# Overview\n\n**Horizm Connect API** is accessed via the [<b>https://app.horizm.com/api/v2</b>](https://app.horizm.com/api/v2) domain.\n\n# Authorization\n\nOur API uses OAuth2 protocol as authorization method.\n\nTo be able to connect with Horizm Connect API, you'll need both a client_id and a client_secret provided by Horizm.\n\nBoth client_id and client_secret are generated by us for our API to be able to recognize that you are allow to gain an access token.\n\n## Step 1\n\nAs a first step, you need to make a request for an authentication code (client_id and the redirect url of your choice should be provided).\n\nSee: Endpoints / Authorization / Get authorization code\n\n## Step 2\n\nOnce you have this code in response, you can ask for an access token (client_id, client_secret, the same url that you've provided in the previous step and the authorization code that you had in response should be provided).\n\nSee: Endpoints / Authorization / Get token\n\n# Status\n\nYou can check the API status by calling /status. API response will be a JSON with a pair status/value.\n\n# **Requests**\n\nAll requests to the API must be made via HTTPS. It is a best practice to include the Content-Type: application/json header in all of your requests.\n\n# Filters\n\nA list of filters that can be applied to the majority of endpoints in the API.\n\nFor connected users only.\n\n- **Timeframe** (from - to)\n    \n- **Brands**: \\[\\] array of brand names (you can check this by using the endpoint: **References/**_**Get brands**_)\n    \n- **Social Networks**: (facebook, instagram, twitter, youtube, tiktok)\n    \n- **Post Types**: (video, photo, album, link, tweet, story, share, igtv, reels, )\n    \n- **Competition**: \\[\\] array of competition names, you can check this by using the endpoint: **References/**_**Get competititons**_)\n    \n- **Content Series**: \\[\\] array of content series id with its names. You can check this by using endpoint **References/Get content series**\n    \n- **Pages**: \\[\\] array of page ids (you can check this by using the endpoint: **References/**_**Get pages**_)\n    \n- **Sections**: \\[\\] array of user sections (you can check this by using the endpoint: **References/**_**Get sections**_)\n    \n- **Condition** (Available / Activated)\n    \n- **Game Related** (Yes / No)\n    \n- **Scope** (Public / Segmented)\n    \n- **Video Duration** (from - to)\n    \n- **Location** {\"countries\": \\[\\]} array of countries (iso2, e.g. ES, DE, PT)\n    \n- **page**: Number of current page (Currently working on Post Analysis > Post List endpoint)\n    \n- **per_page**: Number of results per page (Currently working on Post Analysis > Post List endpoint)\n    \n\n## Full filters definition example\n\nYou can combine this filters as you want in order to query our API endpoints:\n\n``` json\n{\n    \"filters\":[\n        {\n            \"timeFrame\": {\"from\": \"2022-01-01\", \"to\": \"2022-02-01\"},\n            \"brands\": [\"brand_name\", ...],\n            \"socialNetworks\": [\"social_network_name\", ...],\n            \"postTypes\": [\"post_type\", ...],\n            \"competition\": [\"competition_name\", ...],\n            \"content_series\": [\"content_serie_id\", ...],\n            \"pages\": [\"page_id\", ...],\n            \"sections\": [\"section_id\", ...],\n            \"condition\": \"activated\",\n            \"gameRelated\": \"yes\",\n            \"scope\": \"public\",\n            \"videoDuration\": {\"from\": 0, \"to\": 120},\n            \"location\": {\"countries\": [\"country_iso_2\", ...]}\n            \"page\": 1,\n            \"per_page\": 20\n        }\n    ]\n}\n\n ```\n\n# **Response Codes**\n\nThere are three HTTP status classes you are expected to encounter from time-to-time.\n\n**2XX Responses** 2XX responses indicate a successfully completed request.\n\n**4XX series - Request Error** 4XX errors are related to incorrect requests.\n\n**5XX series - System Error** 5XX errors indicate that Horizm cannot fulfil the request.\n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18566491","team":2836722,"collectionId":"f93481f9-4dc5-4835-ab74-3299ef6b227f","publishedId":"UVJeEbXi","public":true,"publicUrl":"https://docs.horizm.com","privateUrl":"https://go.postman.co/documentation/18566491-f93481f9-4dc5-4835-ab74-3299ef6b227f","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":"2024-04-17T08:48:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"CONNECT API PROD","id":"db75e362-3597-4be8-bd28-022ffb4f0293","owner":"18566491","values":[{"key":"horizmConnectAPI","value":"https://app.horizm.com/api/v2","enabled":true,"type":"default"},{"key":"horizmAppURL","value":"https://app.horizm.com","enabled":true,"type":"default"},{"key":"BearerToken","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImUw343OWNkZGEwODgxMTZhOWM0Njg2YzIwZTdiMzQ5MjVkNjM3Y2M1YjY4ZWU3MzQ2NTZhY2Y1ZGM0YzEyZGY1ODlmNDRiYjZhNmI2MmRkNWY5In0.eyJhdWQiOiI3IiwianRpIjoiZTA5Y2RkYTA4ODExNmE5YzQ2ODZjMjBlN2IzNDkyNWQ2MzdjYzViNjhlZTczNDY1NmFjZjVkYzRjMTJkZjU4OWY0NGJiNmE2YjYyZGQ1ZjkiLCJpYXQiOjE2ODI0OTU2MzIsIm5iZiI6MTY4MjQ5NTYzMiwiZXhwIjoxNjgzNzkxNjMwLCJzdWIiOiIzNTE0Iiwic2NvcGVzIjpbXX0.FTHQJHGlSvJMBornoC2Fr6HsPZg9pgxYhrGv14PhBmL0X34Q3F_56UI_UxVsJDZJ2z6DLlXk2No4X3CJX4M3Nk0IpylMebkvc8Cmkf8DN9I7U8-xDgbh13MIab_Qviow7MeWZqu67ao401w3CtnsdEDj-yrOdd4kq8ry-Qxyxl8xQnDasvgznd-AKTdRLQz_Rnml2_5o8DjmfKYS9xKF_RMcavvT6I1oqDAiDWeDbUU_nq5r9n0HC1Shi6qidcIsrGZGjps7yYAoAfFcFoc--lfrScLgpzJ8r3TRwIlNJq2sdvBJ-5Su-GSciMFfTYUtLh7XQRF2YuB-BIf7MqnCM4slSbz7gMHTn1X847S4QX2fp3qrM4FSofgyRIlmsMbC346MDQBKgLeeEpP-H6RwTOPE9Ji6Ji7pHKhBYJgRQnhPJpmJbdRZ-E9hbxDd-gD6xu7Nga8gvwctF7DV2uncKQIfaZmGQQmuaUW4a-GJp4N6IaIcm_Rfw65ovv0aSLobFwTZv5EKgoNQw0lqXBM3ftUFQJABOZnhDlnF2Mza7_C2KBqhjiI_1omPHVpavMvB6r0ZDvP2-KBQhgb296mEsZjAiwMNdF7fq1TK89Zue1i0AV-KJVd-2IbLkQC_gzXNSl0axinK_t66K15DC9EXdE6rZX-R2yB858inbKnO5Jw","enabled":true,"type":"secret"},{"key":"RefreshToken","value":"def50200978ecbabb553fef3f4a63e049ddd44e06b91d865afc2c9ereb6b03aafcb41e53ce8ce97b4b9d99cf8c4b1c23effebe993a3fafdef9870aec04eaa386875e8c3c3762bf8ea7df18977ad6ea9ccc78b6ae5706a2ae30ae82d29befe60bf185001bb4219c04c40478e2632399cc1ec17a925ada70ecd44ca842a831f41b21772da0768038d162c1f233e70a5043dc29f87c0e6ac254df798334c1b7e20a596de29befc40037ee6ae07d314a00106a17d80bed06b193e7cf441032614e0b239da9db46f0b4a0bb378cf22fdafd574dcd77708ed9d4d10d586f2c263914341ad39e3cae1fe1f44ad0ac00764dafaf532ce36b6b5d01eac1de912a08777a0ababa676ee23603f90155f8b1d1e8ef40266486ca9d6ed18b5b08956282343e0e715adf773aadee22fc9ed30ca36d82327c7cc001113e1636594336e40ccee8dd2a94276551abb64fe0b1403c1b0f56ce1134f272e81ca6844bf62763c32b00427d8cbaf6438","enabled":true,"type":"secret"},{"key":"ClientId","value":"7","enabled":true,"type":"secret"},{"key":"ClientSecret","value":"VtInWBcsLOCUQ8O5hddnvmSegMZiRlJOo2MtpyRK","enabled":true,"type":"secret"},{"key":"ClientRedirectUrl","value":"http://localhost:3000/callback","enabled":true,"type":"secret"},{"key":"ClientAuthCode","value":"def502008c825a522e48629c85a27a3dd5819167732788834bf0d38bdc16a23e73f8a3742e8f536cbb8e93dc91fafce8cf1f7df89e200567a12138417faf25d002b72fe0877944844135785bd18743083fc465ad84f75114004d2520add98a1135c944592343bfc67fce43a04eb5341e800f4e71acbc68cffc23d961a31637da1fea02b7fe6b5f322db73b29016e6eb6a3dd5e0893266856577b25f7391745b15bca94c69a7afc0a309d9a70720f99c34670848b1bd05587479e5f5da5eb4237d25bd388d7f5764a686ff2ebe18ce94bc06c476d185061f4b744191da6c1c9ad048a730e1bc25c6f9f403d07ceb86a486d2f59f7ec82717016ef9a60bbda9eb04447c82ed42b95f44f64ffaaeeb132f09c51223267492100895688092b7794feed6267f58c754fa1b302f07d5f2f6fb360bd176d968859c6c6e7a6329d656fe1af73db9ef720770ea916814e6e3dd54dad7c249030c31210e25e984ac0bb2b96444f","enabled":true,"type":"secret"},{"key":"user_email","value":"","enabled":true,"type":"default"},{"key":"user_password","value":"","enabled":true,"type":"default"},{"key":"horizmAPIUrl","value":"https://api.horizm.com","enabled":true},{"key":"bearer_token","value":"","enabled":true,"type":"default"},{"enabled":true,"key":"horizm_backend_split_url","value":"","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/22e33f0d1c1f4ee8a4945eb0bc5bb83946e3897d87fbe3a7fc4f7e7e02f51866","favicon":"https://res.cloudinary.com/postman/image/upload/v1638372118/team/r2ba5rc1qpuerqkidzdy.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":"CONNECT API PROD","value":"18566491-db75e362-3597-4be8-bd28-022ffb4f0293"}],"canonicalUrl":"https://docs.horizm.com/view/metadata/UVJeEbXi"}