get
https://api.ytel.com/v4/campaign/report/
Gets a report of the performance and cost of one or more campaigns. This endpoint is intended to be used by the UI.
Parameters:
- campaignId: Optional. Get a report for a single campaign. If not present will retrieve all.
- templateId: Optional. Get a report for all campaigns that use the given sms template.
- startDate: Optional. Format is YYYY-MM-DD. Will default to 30 days prior to endDate or the last 30 days if not present.
- endDate: Optional. Format is YYYY-MM-DD. Will default to 30 days after startDate* or today if it isn't present.
- grouping: Optional. How to group results. Options: campaign, template, date. If not present will return 1 row with all results.
Response:
- campaignId: Id of the campaign
- campaignName: Name of the campaign
- sends: Number of times this campaign generated a billable outbound event. A campaign that sends multiple messages will over time will have multiple entries.
- replies: Number of inbound messages to this campaign.
- optOuts: Number of DNC requests this campaign has received.
- cost: Base cost of the campaign. Does not include surcharge.
- surcharge: Surcharges that resulted from this campaign.