Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.09 KB

StatisticsApi.md

File metadata and controls

91 lines (63 loc) · 3.09 KB
Raw

messente_api.StatisticsApi

All URIs are relative to https://api.messente.com/v1

Method HTTP request Description
create_statistics_report POST /statistics/reports Requests statistics reports for each country

create_statistics_report

StatisticsReportSuccess create_statistics_report(statistics_report_settings)

Requests statistics reports for each country

Example

  • Basic Authentication (basicAuth):
import messente_api
from messente_api.models.statistics_report_settings import StatisticsReportSettings
from messente_api.models.statistics_report_success import StatisticsReportSuccess
from messente_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.messente.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = messente_api.Configuration(
    host = "https://api.messente.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = messente_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with messente_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = messente_api.StatisticsApi(api_client)
    statistics_report_settings = {"start_date":"2017-01-01","end_date":"2019-06-20","message_types":["sms"]} # StatisticsReportSettings | Settings for statistics report

    try:
        # Requests statistics reports for each country
        api_response = api_instance.create_statistics_report(statistics_report_settings)
        print("The response of StatisticsApi->create_statistics_report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatisticsApi->create_statistics_report: %s\n" % e)

Parameters

Name Type Description Notes
statistics_report_settings StatisticsReportSettings Settings for statistics report

Return type

StatisticsReportSuccess

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Created reports by countries -
400 Client Error -
401 Unauthorized -
422 Invalid data -
500 Internal Server Error -

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