Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.55 KB

ReportsApi.md

File metadata and controls

83 lines (56 loc) · 3.55 KB
Raw

{{classname}}

All URIs are relative to https://slingshot.egoiapp.com/api/

Method HTTP request Description
ProduceEmailReport Get /v2/email/reports Get Email Report
ProduceSmsReport Get /v2/sms/reports Get Sms Report

ProduceEmailReport

[]EmailReportResponse ProduceEmailReport(ctx, optional) Get Email Report

Retrieve Mail Reports and Statistics. Entries can be customizable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ReportsApiProduceEmailReportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReportsApiProduceEmailReportOpts struct

Name Type Description Notes
group optional.String The name of the group to search
groupBy optional.String The option to group the results. Can be either ``day`` or ``month``. Defaults to ``day`` if none are present
dateStart optional.String The date to start the report. Date must be in format ``yyyy-MM-dd``
dateEnd optional.String The date to end the report. Date should be in format ``yyyy-MM-dd``

Return type

[]EmailReportResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ProduceSmsReport

[]SmsReportResponse ProduceSmsReport(ctx, optional) Get Sms Report

Retrieve Sms Reports and Statistics. Entries can be customizable

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ReportsApiProduceSmsReportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReportsApiProduceSmsReportOpts struct

Name Type Description Notes
group optional.String The id of the group to search
groupBy optional.String The option to group the results. Can be either ``day`` or ``month``. Defaults to ``day`` if none are present
dateStart optional.String The date to start the report. Date must be in format ``yyyy-MM-dd``
dateEnd optional.String The date to end the report. Date should be in format ``yyyy-MM-dd``

Return type

[]SmsReportResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]