GET

/v1/apps/{application-id}/segments/{segment-id}/jobs/export

http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/segments/{segment-id}/jobs/export

Retrieves information about the status and settings of the export jobs for a segment.

Access Token Required: API Key

Path Parameters

application-idstringrequired

The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.

segment-idstringrequired

The unique identifier for the segment.

Query Params

page-sizestring

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

tokenstring

The NextToken string that specifies which page of results to return in a paginated response.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/segments/{segment-id}/jobs/export' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}