{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6b60f7f9-bee8-4db2-b0e7-6b0f2fa19913","name":"Ads (public)","description":"The Ads API is organized around REST. Our API has resource-oriented URLs, accepts json-encoded request bodies, returns json-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Authentication\n\nThe Ads API uses an API Key to authenticate requests.\n\nFor authenticated request, se the header `X-API-KEY` with the api key value. To manage and retrieve API Keys, login to your account and navigate to `Tracking` `>` `Api Keys`.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\nFor documentation purposes, a sample API Request using the API key is included in this and all the examples:\n\n```\ncurl --location --request POST 'https://api.ads.com/ads/domain/search' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'X-API-KEY: ••••••' \\\n--data ''\n\n ```\n\nTo test example requests using your account, replace the sample API key with your actual API key.\n\n# Errors\n\nAds uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted or is invalid, etc.). Codes in the `5xx` range indicate an error with Ads servers.\n\n## Security Vulnerabilities or Errors\n\nIf you discover a security vulnerability or an error within the Ads API, please send an e-mail to our support team via [support@ads.com](https://mailto:support@bodis.com). All reported issues will be promptly addressed.\n\n# Parameters\n\nAll request parameters described throughout the documentation for each endpoint are case-sensitive. When making a request you'll want to ensure the parameters are sent as documented.\n\n# HTTP Status Codes\n\nAn overview of HTTP status codes that may be encountered while interacting with the API.\n\n**200** - _Ok_\n\nEverything worked as expected.\n\n---\n\n**201** - _Created_\n\nEverything worked as expected. Resource was created.\n\n---\n\n**204** - _No Content_\n\nEverything worked as expected. Resource has provided no additional response details.\n\n---\n\n**400** - _Bad Request_\n\nThe request was unacceptable, often due to missing or invalid parameters.\n\n---\n\n**401** - _Unauthorized_\n\nNo valid API key provided.\n\n---\n\n**403** - _Forbidden_\n\nThe API key doesn't have permissions to perform the request.\n\n---\n\n**404** - _Not Found_\n\nThe requested resource doesn't exist.\n\n---\n\n**422** - _Unprocessable Entity_\n\nThe request was unacceptable, often due to missing or invalid parameters.\n\n---\n\n**429** - _Too Many Requests_\n\nToo many requests hit the API too quickly.\n\n---\n\n**500, 502, 503, 504** - _Server Errors_\n\nSomething went wrong on API end.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9385213","team":568679,"collectionId":"6b60f7f9-bee8-4db2-b0e7-6b0f2fa19913","publishedId":"2s8YzTTMpn","public":true,"publicUrl":"https://docs.ads.com","privateUrl":"https://go.postman.co/documentation/9385213-6b60f7f9-bee8-4db2-b0e7-6b0f2fa19913","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"b2006a"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/03b0eece-256c-4e2f-ae04-748c1a227c2c/QURTLUxPR08tQ09MT1IucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"B2006A"}},{"name":"light","logo":"https://content.pstmn.io/03b0eece-256c-4e2f-ae04-748c1a227c2c/QURTLUxPR08tQ09MT1IucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"b2006a"}}]}},"version":"8.10.1","publishDate":"2023-07-10T15:29:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/03b0eece-256c-4e2f-ae04-748c1a227c2c/QURTLUxPR08tQ09MT1IucG5n","logoDark":"https://content.pstmn.io/03b0eece-256c-4e2f-ae04-748c1a227c2c/QURTLUxPR08tQ09MT1IucG5n"}},"statusCode":200},"environments":[{"name":"Prod","id":"d7f1825b-cf14-4f0d-a903-73356b6512f6","owner":"9385213","values":[{"key":"baseUrl","value":"https://api.ads.com/ads","enabled":true},{"key":"token","value":"","enabled":true,"type":"default"},{"key":"credentials","value":"","enabled":true,"type":"default"},{"key":"access_token","value":"","enabled":true,"type":"default"},{"key":"account_token","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/038b433ebced92b32c66359e43390dc4b050d61cb246431701c2e374127127e7","favicon":"https://res.cloudinary.com/postman/image/upload/v1689151217/team/ssmwmwgebywqczack6yf.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":"Prod","value":"9385213-d7f1825b-cf14-4f0d-a903-73356b6512f6"}],"canonicalUrl":"https://docs.ads.com/view/metadata/2s8YzTTMpn"}