:doc:`Pinpoint <../../pinpoint>` / Client / get_campaign_activities

***********************
get_campaign_activities
***********************



.. py:method:: Pinpoint.Client.get_campaign_activities(**kwargs)

  

  Retrieves information about all the activities for a campaign.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivities>`_  


  **Request Syntax**
  ::

    response = client.get_campaign_activities(
        ApplicationId='string',
        CampaignId='string',
        PageSize='string',
        Token='string'
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique identifier for the application. This identifier is displayed as the **Project ID** on the Amazon Pinpoint console.

    

  
  :type CampaignId: string
  :param CampaignId: **[REQUIRED]** 

    The unique identifier for the campaign.

    

  
  :type PageSize: string
  :param PageSize: 

    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.

    

  
  :type Token: string
  :param Token: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ActivitiesResponse': {
              'Item': [
                  {
                      'ApplicationId': 'string',
                      'CampaignId': 'string',
                      'End': 'string',
                      'Id': 'string',
                      'Result': 'string',
                      'ScheduledStart': 'string',
                      'Start': 'string',
                      'State': 'string',
                      'SuccessfulEndpointCount': 123,
                      'TimezonesCompletedCount': 123,
                      'TimezonesTotalCount': 123,
                      'TotalEndpointCount': 123,
                      'TreatmentId': 'string',
                      'ExecutionMetrics': {
                          'string': 'string'
                      }
                  },
              ],
              'NextToken': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **ActivitiesResponse** *(dict) --* 

        Provides information about the activities that were performed by a campaign.

        
        

        - **Item** *(list) --* 

          An array of responses, one for each activity that was performed by the campaign.

          
          

          - *(dict) --* 

            Provides information about an activity that was performed by a campaign.

            
            

            - **ApplicationId** *(string) --* 

              The unique identifier for the application that the campaign applies to.

              
            

            - **CampaignId** *(string) --* 

              The unique identifier for the campaign that the activity applies to.

              
            

            - **End** *(string) --* 

              The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

              
            

            - **Id** *(string) --* 

              The unique identifier for the activity.

              
            

            - **Result** *(string) --* 

              Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

              
            

            - **ScheduledStart** *(string) --* 

              The scheduled start time, in ISO 8601 format, for the activity.

              
            

            - **Start** *(string) --* 

              The actual start time, in ISO 8601 format, of the activity.

              
            

            - **State** *(string) --* 

              The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

              
            

            - **SuccessfulEndpointCount** *(integer) --* 

              The total number of endpoints that the campaign successfully delivered messages to.

              
            

            - **TimezonesCompletedCount** *(integer) --* 

              The total number of time zones that were completed.

              
            

            - **TimezonesTotalCount** *(integer) --* 

              The total number of unique time zones that are in the segment for the campaign.

              
            

            - **TotalEndpointCount** *(integer) --* 

              The total number of endpoints that the campaign attempted to deliver messages to.

              
            

            - **TreatmentId** *(string) --* 

              The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

              
            

            - **ExecutionMetrics** *(dict) --* 

              A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see `Standard Amazon Pinpoint analytics metrics <https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html>`__ in the *Amazon Pinpoint Developer Guide*.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

          
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Pinpoint.Client.exceptions.NotFoundException`

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  