Data retrieval APIs for Amazon Pinpoint
Amazon Pinpoint provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| GetAdmChannel | Retrieve information about the Amazon Device Messaging (ADM) channel for an app | Read |
| GetApnsChannel | Retrieve information about the APNs channel for an app | Read |
| GetApnsSandboxChannel | Retrieve information about the APNs sandbox channel for an app | Read |
| GetApnsVoipChannel | Retrieve information about the APNs VoIP channel for an app | Read |
| GetApnsVoipSandboxChannel | Retrieve information about the APNs VoIP sandbox channel for an app | Read |
| GetApp | Retrieve information about a specific app in your Amazon Pinpoint account | Read |
| GetApplicationDateRangeKpi | Retrieve (queries) pre-aggregated data for a standard metric that applies to an application | Read |
| GetApplicationSettings | Retrieve the default settings for an app | List |
| GetApps | Retrieve a list of apps in your Amazon Pinpoint account | Read |
| GetBaiduChannel | Retrieve information about the Baidu channel for an app | Read |
| GetCampaign | Retrieve information about a specific campaign | Read |
| GetCampaignActivities | Retrieve information about the activities performed by a campaign | List |
| GetCampaignDateRangeKpi | Retrieve (queries) pre-aggregated data for a standard metric that applies to a campaign | Read |
| GetCampaignVersion | Retrieve information about a specific campaign version | Read |
| GetCampaignVersions | Retrieve information about the current and prior versions of a campaign | List |
| GetCampaigns | Retrieve information about all campaigns for an app | List |
| GetChannels | Get all channels information for your app | List |
| GetEmailChannel | Obtain information about the email channel in an app | Read |
| GetEmailTemplate | Retrieve information about a specific or the active version of an email template | Read |
| GetEndpoint | Retrieve information about a specific endpoint | Read |
| GetEventStream | Retrieve information about the event stream for an app | Read |
| GetExportJob | Obtain information about a specific export job | Read |
| GetExportJobs | Retrieve a list of all of the export jobs for an app | List |
| GetGcmChannel | Retrieve information about the GCM channel for an app | Read |
| GetImportJob | Retrieve information about a specific import job | Read |
| GetImportJobs | Retrieve information about all import jobs for an app | List |
| GetInAppMessages | Retrive in-app messages for the given endpoint id | Read |
| GetInAppTemplate | Retrieve information about a specific or the active version of an in-app message template | Read |
| GetJourney | Retrieve information about a specific journey | Read |
| GetJourneyDateRangeKpi | Retrieve (queries) pre-aggregated data for a standard engagement metric that applies to a journey | Read |
| GetJourneyExecutionActivityMetrics | Retrieve (queries) pre-aggregated data for a standard execution metric that applies to a journey activity | Read |
| GetJourneyExecutionMetrics | Retrieve (queries) pre-aggregated data for a standard execution metric that applies to a journey | Read |
| GetJourneyRunExecutionActivityMetrics | Retrieve (queries) pre-aggregated data for a standard execution metric that applies to a journey activity for a single journey run | Read |
| GetJourneyRunExecutionMetrics | Retrieve (queries) pre-aggregated data for a standard execution metric that applies to a journey for a single journey run | Read |
| GetJourneyRuns | Retrieve information about all journey runs for a journey | List |
| GetPushTemplate | Retrieve information about a specific or the active version of an push notification template | Read |
| GetRecommenderConfiguration | Retrieve information about an Amazon Pinpoint configuration for a recommender model | Read |
| GetRecommenderConfigurations | Retrieve information about all the recommender model configurations that are associated with an Amazon Pinpoint account | List |
| GetReports | Mobiletargeting:GetReports | Read |
| GetSegment | Retrieve information about a specific segment | Read |
| GetSegmentExportJobs | Retrieve information about jobs that export endpoint definitions from segments to Amazon S3 | List |
| GetSegmentImportJobs | Retrieve information about jobs that create segments by importing endpoint definitions from | List |
| GetSegmentVersion | Retrieve information about a specific segment version | Read |
| GetSegmentVersions | Retrieve information about the current and prior versions of a segment | List |
| GetSegments | Retrieve information about the segments for an app | List |
| GetSmsChannel | Obtain information about the SMS channel in an app | Read |
| GetSmsTemplate | Retrieve information about a specific or the active version of an sms message template | Read |
| GetUserEndpoints | Retrieve information about the endpoints that are associated with a user ID | Read |
| GetVoiceChannel | Obtain information about the Voice channel in an app | Read |
| GetVoiceTemplate | Retrieve information about a specific or the active version of a voice message template | Read |
| ListJourneys | Retrieve information about all journeys for an app | List |
| ListTagsForResource | List tags for a resource | Read |
| ListTemplateVersions | Retrieve all versions about a specific template | List |
| ListTemplates | Retrieve metadata about the queried templates | List |
| PhoneNumberValidate | Obtain metadata for a phone number, such as the number type (mobile, landline, or VoIP), location, and provider | Read |
