Pre-Existing Report: All Customers

Generate a report with all the customers who have had transactions between two date ranges in the selected campaigns.

See more

Pre-Existing Report: New Customers

Generate a report with all the customers who have had their first transaction between two date ranges in the selected campaigns.

See more

Pre-Existing Report: Frequent Customers

Generate a report with all the customers who have had a certain amount of transaction between two date ranges in the selected campaigns.

See more

Pre-Existing Report: Missing Customers

Generate a report with all the customers who have had a transaction between two date ranges in the selected campaigns, but haven't ben back for a given amount of days.

See more

Pre-Existing Report: Customers Birthday

Generate a report with all the customers who have had a transaction in the selected campaigns and who will celebrate a birthday in the given date range.

See more

Pre-Existing Report: Custom Date Search

Generate a report with all the customers who have had a transaction in the selected campaigns and whose custom_date field includes a date in the given date range.

See more

Pre-Existing Report: Search Customers

Generate a report with all the customers who have a transaction between two date ranges in the selected campaigns, and whose information contains the search text.

See more
Back to Top

Pre-Existing Report: All Customers

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_all Required
date_start 2010-01-01 Optional
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Optional
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • If the date_start, date_end, and selected_campaigns are not provided, any customer in the database will be returned, whether they have ever had a transaction or not.
  • If at least on campaign ID is provided, the customers returned will have had a transaction in the campaign(s)
  • Dates provided without any campaigns will be ignored. You need to provide at least one campaign in order to restrict customers to having had transactions within the date range provided.
  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_all';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <customer_code>4137071924090694</customer_code>
                      <card_number>11111111</card_number>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: New Customers

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_new Required
date_start 2010-01-01 Required
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_new3';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <customer_code>4137071924090694</customer_code>
                      <card_number>11111111</card_number>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: Frequent Customers

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_frequent Required
date_start 2010-01-01 Required
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Required
frequency 10 Required
include_redeemed Y Optional
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)
  • By default include_redeemed equals "No" (ie: The report does not count "redeem" transactions.) To include those, add the include_redeemed field and set it to "Y".

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_frequent';
              $data['frequency'] = '10';
              $data['include_redeemed'] = 'Y';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <card_number>11111111</card_number>
                      <customer_code>4137071924090694</customer_code>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: Missing Customers

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_missing Required
date_start 2010-01-01 Required
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Required
missing_for 90 Required
(days)
include_redeemed Y Optional
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)
  • By default include_redeemed equals "No" (ie: The report does not count "redeem" transactions.) To include those, add the include_redeemed field and set it to "Y".

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_missing';
              $data['frequency'] = '90';
              $data['include_redeemed'] = 'Y';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer> 									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <card_number>11111111</card_number>
                      <customer_code>4137071924090694</customer_code>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: Customers Birthday

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_birthday Required
date_start 2011-08-01 Required
date_end 2011-08-31 Optional
selected_campaigns 123456789012,21987654321 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_birthday';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <card_number>11111111</card_number>
                      <customer_code>4137071924090694</customer_code>
                  </customer>
                  ...
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: Custom Date Search

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_custom_date Required
date_start 2011-08-01 Required
date_end 2011-08-31 Optional
selected_campaigns 123456789012,21987654321 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_custom_date';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <card_number>11111111</card_number>
                  <customer_code>4137071924090694</customer_code>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>
          
Back to Top

Pre-Existing Report: Search Customers

The data to be submitted to the API is composed of the following fields:

field Example Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_search Required
date_start 2010-01-01 Required
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Required
search_text Doe Required
include_transactions_search Y Optional
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

Notes:

  • The date_start and date_end will restrict search results to only those customers that have had a transaction in that date range.
  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)
  • The search_text will be searched across all customer's data, based on partial matching.
  • The include_transactions_search optional parameter allows searching across the customers' transactions data as well.

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['user_id']        = 'john1970';
              $data['user_password'] 	= '1959caadac9b13dcb3';
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'reports';
              $data['report'] = 'customers_search';
              $data['search_text'] = 'cheese';
              $data['date_start'] = '2010-01-01';
              $data['date_end'] = '2011-12-31';
              $data['selected_campaigns'] = '123456789012,210987654321';
          

Success XML Response (New / Updated User):


              <response status="success">
                  <customer>									<first_name>Jane</first_name>
                      <last_name>Doe</last_name>
                      <phone>555-5555</phone>
                      <email>jdoe@email.com</email>
                      <address1>123 Main St.</address1>
                      <address2>Apt 3G</address2>
                      <city>Anytown</city>
                      <state>ND</state>
                      <zip>12345</zip>
                      <country>New Zealand</country>
                      <custom1>She likes cheese!</custom1>
                      <custom_date>1970-07-14</custom_date>
                      <customer_username>jdoe123</customer_username>
                      <card_number>11111111</card_number>
                      <customer_code>4137071924090694</customer_code>
                  </customer>
                  <customer>
                  ...
                  </customer>
              </response>
          

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>