get https://api.chartmogul.com/v1/activities_export/
Returns an activities report with a list of activities for the specified time period.
Examples
curl -X GET "https://api.chartmogul.com/v1/activities_export/17042239-3674-4a61-b838-b6b307f28506" \
-u YOUR_API KEY:
# Available from chartmogul-ruby >= 2.0.0
ChartMogul::Metrics::ActivitiesExport.retrieve("17042239-3674-4a61-b838-b6b307f28506")
ChartMogul.Metrics.ActivitiesExport.retrieve(
config,
"17042239-3674-4a61-b838-b6b307f28506"
);
ChartMogul\Metrics\ActivitiesExport::retrieve("17042239-3674-4a61-b838-b6b307f28506");
api.MetricsRetrieveActivitiesExport("17042239-3674-4a61-b838-b6b307f28506")
chartmogul.ActivitiesExport.retrieve(config, id="17042239-3674-4a61-b838-b6b307f28506")
Result Format
{
"id": "17042239-3674-4a61-b838-b6b307f28506",
"status": "succeeded",
"file_url": "https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip",
"params": {
"kind": "activities",
"params": {
"end_date": "2022-12-31 00:00:00 +0000",
"start_date": "2022-01-01 00:00:00 +0000",
"activity_type": "new_biz"
}
},
"expires_at": "2023-07-16T14:37:43+00:00",
"created_at": "2023-07-09T14:37:32+00:00"
}
#<ChartMogul::Metrics::ActivitiesExport:0x00007f8efa397570
@created_at="2023-07-09T14:37:32+00:00",
@expires_at="2023-07-16T14:37:43+00:00",
@file_url=
"https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip",
@id="17042239-3674-4a61-b838-b6b307f28506",
@params={
:kind=>"activities",
:params=>{
:end_date=>"2022-12-31 00:00:00 +0000",
:start_date=>"2022-01-01 00:00:00 +0000",
:activity_type=>"new_biz"
}
},
@status="succeeded"
>
{
id: "17042239-3674-4a61-b838-b6b307f28506",
status: "succeeded",
file_url: "https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip",
params: {
kind: "activities",
params: {
end_date: "2022-12-31 00:00:00 +0000",
start_date: "2022-01-01 00:00:00 +0000",
activity_type: "new_biz"
}
},
expires_at: "2023-07-16T14:37:43+00:00",
created_at: "2023-07-09T14:37:32+00:00"
}
class ChartMogul\Metrics\ActivitiesExport#8027 (10) {
protected $id => string(36) "17042239-3674-4a61-b838-b6b307f28506"
protected $status => string(9) "succeeded"
protected $file_url => string(123) "https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip"
protected $params => array(2) {
"kind" => string(10) "activities"
"params" => array(3) {
"activity_type" => string(11) "new_biz"
"start_date" => string(10) "2022-01-01"
"end_date" => string(10) "2022-12-31"
}
}
protected $expires_at => string(25) "2023-07-16T14:37:43+00:00"
protected $created_at => string(25) "2023-07-09T14:37:32+00:00"
}
(*chartmogul.MetricsActivitiesExport)(0xc0000acc60)({
ID: (string) (len=36) "17042239-3674-4a61-b838-b6b307f28506",
Status: (string) (len=9) "succeeded",
FileURL: (string) (len=123) "https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip",
Params: (chartmogul.Params) {
Kind: (string) (len=10) "activities",
Params: (chartmogul.NestedParams) {
ActivityType: (string) (len=11) "new_biz",
StartDate: (string) (len=10) "2022-01-01",
EndDate: (string) (len=10) "2022-12-31"
}
},
ExpiresAt: (string) (len=25) "2023-07-16T14:37:43+00:00",
CreatedAt: (string) (len=25) "2023-07-09T14:37:32+00:00"
})
<ActivitiesExport{
created_at=datetime.datetime(2023, 7, 9, 14, 37, 32, tzinfo=datetime.timezone(datetime.timedelta(0), "+0000")),
expires_at=datetime.datetime(2023, 7, 16, 14, 37, 32, tzinfo=datetime.timezone(datetime.timedelta(0), "+0000")),
file_url="https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip",
id="17042239-3674-4a61-b838-b6b307f28506",
params={"kind": "activities", "params": {}},
status="succeeded"
}>
The response contains the following data:
id- This is the ID of the activities export.status- Initially, this will be pending and then move to processing followed by failed or succeeded.file_url- Initially this will be null. Upon successful status, it will be populated with a URL to the zipped export.params- This provides details on the requested export, as submitted by you in the body of the POST request.expires_at- Initially this will be null. Once the file_url is populated, it will state the timestamp at which the file_url will expire.created_at- This is a timestamp.