Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSegmentEstimate

Gets the result of a segment estimate query.

Request Syntax


GET /domains/DomainName/segment-estimates/EstimateId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

EstimateId

The query Id passed by a previous CreateSegmentEstimate operation.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 StatusCode
Content-type: application/json

{
   "DomainName": "string",
   "Estimate": "string",
   "EstimateId": "string",
   "Message": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

StatusCode: The status code of the segment estimate.

The following data is returned in JSON format by the service.

DomainName

The unique name of the domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Estimate

The estimated number of profiles contained in the segment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

EstimateId

The QueryId which is the same as the value passed in QueryId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Message

The error message if there is any error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Status

The current status of the query.

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429