{"_id":"560150faf01fb90d00d4bfa6","project":"55dd9f2e0efd5821000d54d9","editedParams2":true,"parentDoc":null,"user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":2,"category":{"_id":"55f036fa8563861700a3376b","pages":["560147954ea1b40d003bf1de","560150faf01fb90d00d4bfa6"],"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":2,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:41:14.074Z","from_sync":false,"order":11,"slug":"segments","title":"Segments"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T13:00:42.207Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/segments/refresh/1\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.GetAsync(url).Result;\n}"},{"language":"json","code":""},{"code":"$url = $baseUrl . “/v2/segments/refresh/1“;\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n\t$ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n    \t'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n\t$ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\n\t\t\t\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"get","results":{"codes":[{"code":"{\n  \"id\": 1,\n  \"status\": \"Finished\"\n}","language":"json","status":200,"name":""}]},"settings":"","auth":"required","params":[{"_id":"56000f150c703d190095300a","ref":"","in":"path","required":true,"desc":"The ID of the segment, which needs to be included within the URL","default":"","type":"int","name":"ID"}],"url":"/v:version/segments/refresh/[ID]"},"isReference":false,"order":2,"body":"This operation retrieves the status of a segment refresh via its ID.\n\nThe possible status types are:\n\n  * 'NotStarted' - The segment refresh hasn't started yet\n  * 'NotFinished' - The segment refresh is underway but has yet to finish\t \n  * 'Finished' - The segment refresh has finished\n  * 'Failed' - The segment refresh has failed\t\n  * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Gets the refresh progress for a segment","slug":"get-refresh-progress-for-segment","type":"endpoint","title":"Get refresh progress for segment"}

getGet refresh progress for segment

Gets the refresh progress for a segment

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the segment, which needs to be included within the URL

Examples


Result Format


Documentation

This operation retrieves the status of a segment refresh via its ID. The possible status types are: * 'NotStarted' - The segment refresh hasn't started yet * 'NotFinished' - The segment refresh is underway but has yet to finish * 'Finished' - The segment refresh has finished * 'Failed' - The segment refresh has failed * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using