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

CreateSegmentEstimate

Creates a segment estimate query.

Request Syntax


POST /domains/DomainName/segment-estimates HTTP/1.1
Content-type: application/json

{
   "SegmentQuery": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { ... }
            ],
            "SourceSegments": [ 
               { 
                  "SegmentDefinitionName": "string"
               }
            ],
            "SourceType": "string",
            "Type": "string"
         }
      ],
      "Include": "string"
   }
}

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

Request Body

The request accepts the following data in JSON format.

SegmentQuery

The segment query for calculating a segment estimate.

Type: SegmentGroupStructure object

Required: Yes

Response Syntax


HTTP/1.1 StatusCode
Content-type: application/json

{
   "DomainName": "string",
   "EstimateId": "string"
}

Response Elements

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

StatusCode: The status code for the response.

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_-]+$

EstimateId

A unique identifier for the resource. The value can be passed to GetSegmentEstimate to retrieve the result of segment estimate status.

Type: String

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

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