Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.69 KB

AccountApi.md

File metadata and controls

68 lines (43 loc) · 2.69 KB

\AccountApi

All URIs are relative to https://api.brevo.com/v3

Method HTTP request Description
GetAccount Get /account Get your account information, plan and credits details
GetAccountActivity Get /organization/activities Get user activity logs

GetAccount

GetAccount GetAccount(ctx, ) Get your account information, plan and credits details

Required Parameters

This endpoint does not need any parameter.

Return type

GetAccount

Authorization

api-key, partner-key

HTTP request headers

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

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

GetAccountActivity

GetAccountActivity GetAccountActivity(ctx, optional) Get user activity logs

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAccountActivityOpts struct

Name Type Description Notes
startDate optional.String Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
endDate optional.String Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
limit optional.Int64 Number of documents per page [default to 10]
offset optional.Int64 Index of the first document in the page. [default to 0]

Return type

GetAccountActivity

Authorization

api-key, partner-key

HTTP request headers

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

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