Using the MailChimp Retrieve All Reports Activity

Use the Retrieve All Objects activity to retrieve Campaign Feedback Report, Click Report, Click Reports, Domain Performance Report, Social Activity Report, Email Activity Report, Location Report, Recipients Report, Campaign Sub Report, and Unsubscribed Member Report from MailChimp.

About this task

Use this task to retrieve all reports in MailChimp instance. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.

Procedure

  1. In an active orchestration, open the Activities tab and expand the MailChimp folder contents.
  2. Drag the Retrieve All Reports activity icon onto the orchestration. Select the activity. The MailChimp Retrieve All Reports Checklist is displayed.
  3. In the checklist, click Summary.
  4. Review the contents of the Activity Name field, and make the required changes.
  5. In the checklist, click Pick Endpoint.
  6. Click Browse and use the Project Explorer dialog box to select the relevant MailChimp endpoint.
  7. Optional: You can create the endpoint by clicking New and specifying the required connection details. Click OK to save and use the endpoint for this configuration.
  8. To make required changes to the selected endpoint configuration, click Edit to access the options in a separate window. Any changes you make globally affects all uses of the endpoint in active orchestrations.
  9. In the checklist, click Configure.
  10. Object Type browse is available.
  11. Click Browse to select an object. The Browse MailChimp window is displayed.
  12. In the Object Type Browse MailChimp window, you can select the MailChimp object types from the object type list. Click OK.
  13. In the Checklist, click Retry. Review the default settings and make the required changes.
  14. Select the Map Inputs in the Checklist. The XML Schemas generated from the selected object of the Retrieve All Reports activity are displayed as nodes under the request input parameter in the To Activity panel.
  15. Create a map between the orchestration variables and the input parameter of the activity.
    Note: Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
  16. Select the Map Outputs in the Checklist. The XML Schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
  17. Create a map between the output parameters and orchestration variables.

    Query Parameter

    Below are the query parameters of the Retrieve All Reports:

    Table 1. Query Parameter
    Field Name Description
    fieldFilter It holds fieldSelectionOption and list of fields. This set of parameters are optional. If the values are not provided then entire object response will be displayed.
    fieldSelectionOption This parameter is used to manage the response fields. Allowed values are INCLUDE or EXCLUDE. User must specify this value. If ‘INCLUDE’ option is given, only values for selected ‘fields’ element will be present in response. If ‘EXCLUDE option is given, values of selected ‘fields’ element will be absent in response.
    fields This is list of standard object field names that can be present or absent in the response. User can be specify multiple fields by expanding occurrences.
    criteria It holds field, and value. This set of parameters are optional. If the values are not provided then entire object response will be displayed. Multiple criteria can be specified by expanding occurrences for the criteria node.
    field The standard object field name to be used in the criteria. User must specify this value.
    value The value of the field used in the search. User must specify this value.
    count It is used for pagination. By default count is 10.
    offset It is used for pagination. By default offset is 0.

Results

You have configured the MailChimp Retrieve All Reports activity.
Note:
  • fieldFilter is optional. To support partial response, set ‘fieldSelectionOption’ value as either ‘INCLUDE’ or ‘EXCLUDE’. ‘fields’ should have element name to be excluded and included. Expand occurrence to have support multiple fields.
  • ‘criteria’ supports the filtering feature, where in field is name of the element and value is value to be looked for. Expand the occurrence of ‘criteria’ for different set of filters.
  • ‘count’ and offset is used for pagination. By default count is 10 and offset as 0.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/MailChimp_retrieve_all_reports_activity.html