Export campaign report

In this article, you'll learn how to export campaign data.

You can export your data on Taximail in two modes, general or recipient. You can send get request by sending campaign export API.

General data exporting

  • This API endpoint allows you to export your data.
  • You can export campaign with 2 modes ( general or recipients ).
  • You can send GET request to campaign/{campaign_id}/export API.
  • Taximail API will return path files to get downloaded.

GET https://api.taximail.com/v2/campaign/{campaign_id}/export

Parameter Type Description Required
start_date string Datetime start to specified of data to export
end_date string Datetime end to specified of data to export

Note
start_date and end_date : When you want to specify datetime with pattern yyyy-mm-dd hh:mm:ss for export data, see the example below.
Ex. " 2015-06-15 06:23:12 " or " 2016-03-25 06:23:12 "

Example Request

GET v2/campaign/315/export HTTP/1.1
Host: api.taximail.com

Authorization: "Bearer YOUR_SESSION_ID"

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
              "url": "https://file.taximail.com/stocks/export_campaign/Cmpgn-16-1948-20160106-c5MEq8kr.zip"
          }
}

Fields

Name Type Description
status enum {success, error} Returns the status of the result.
code integer Returns the response code of the result.
err_msg string When error occur, returns the error's detail of the result.
data.url string Return path of file export campaign for download.

Response Code

Code Result Description
201 success The new resource was created successfully.
400 error The request is malformed or missing some required parameters.
401 error Unauthorized or the session_id expired.
404 error The campaign not found.

Recipients of data exporting

  • You can send GET request to campaign/{campaign_id}/recipients_export API.
  • Taximail API will return path files to get downloaded.

GET https://api.taximail.com/v2/campaign/{campaign_id}/recipients_export

Example Request

GET v2/campaign/315/recipients_export HTTP/1.1
Host: api.taximail.com
Authorization: "Bearer YOUR_SESSION_ID"

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
              "url": "https://file.taximail.com/stocks/export_campaign/Cmpgnrcp-16-1948-20160106-iJ9DGZ44.zip"
          }
}

Fields

Name Type Description
status enum {success, error} Returns the status of the result.
code integer Returns the response code of the result.
err_msg string When error occur, returns the error's detail of the result.
data.url string Return path of file export campaign for download.

Response Code

Code Result Description
201 success The new resource was created successfully.
400 error The request is malformed or missing some required parameters.
401 error Unauthorized or the session_id expired.
404 error The campaign not found.
Title
Title SEO [Optional]
Description SEO [Optional]
Friendly URL [Optional]
IFRAME Content [Optional]
Priority
Markdown
We use cookies
This website uses cookies to enhance your browsing experience on our website, to show you personalized content and targeted ads, to analyze our website traffic, and to understand where our visitors are coming from. You can manage your preferences by clicking Change Preferences. Learn more about this on Cookie policy
Change Preferences
Accept All