SubscriptionsApi

All URIs are relative to /

Method	HTTP request	Description
createForAppUsingPOST	POST /users-web/api/v3/apps/{appId}/subscription	Create App subscription
createForDashUsingPOST	POST /users-web/api/v3/dashboards/{dashId}/subscription	Create dashboard subscription
deleteUsingDELETE3	DELETE /users-web/api/v3/subscriptions/{updateableSubscriptionId}	Delete subscription
listUsingGET3	GET /users-web/api/v3/apps/{appId}/subscriptions	Get subscriptions for an App
listUsingGET5	GET /users-web/api/v3/subscriptions	Get current account's subscriptions
sendAppReportUsingPOST1	POST /users-web/api/v3/apps/{appId}/report/send	Email an App report
sendDashReportUsingPOST	POST /users-web/api/v3/dashboards/{dashId}/report/send	Email a dashboard report
toggleEnabledUsingPUT	PUT /users-web/api/v3/subscriptions/{updateableSubscriptionId}	Toggle subscription status
updateForAppUsingPUT	PUT /users-web/api/v3/apps/{appId}/subscription	Update App subscription
updateForDashUsingPUT1	PUT /users-web/api/v3/dashboards/{dashId}/subscription	Update dashboard subscription

createForAppUsingPOST

SubscriptionResponse createForAppUsingPOST(body, appId)

Create App subscription

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
SubscriptionDto body = new SubscriptionDto(); // SubscriptionDto | subscription
Long appId = 789L; // Long | appId
try {
    SubscriptionResponse result = apiInstance.createForAppUsingPOST(body, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#createForAppUsingPOST");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	SubscriptionDto	subscription
appId	Long	appId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

createForDashUsingPOST

SubscriptionResponse createForDashUsingPOST(body, dashId)

Create dashboard subscription

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
SubscriptionDashboardDto body = new SubscriptionDashboardDto(); // SubscriptionDashboardDto | subscription
Long dashId = 789L; // Long | dashId
try {
    SubscriptionResponse result = apiInstance.createForDashUsingPOST(body, dashId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#createForDashUsingPOST");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	SubscriptionDashboardDto	subscription
dashId	Long	dashId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

deleteUsingDELETE3

GenericMapBasedApiResponse deleteUsingDELETE3(updateableSubscriptionId)

Delete subscription

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
Long updateableSubscriptionId = 789L; // Long | updateableSubscriptionId
try {
    GenericMapBasedApiResponse result = apiInstance.deleteUsingDELETE3(updateableSubscriptionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#deleteUsingDELETE3");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
updateableSubscriptionId	Long	updateableSubscriptionId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

listUsingGET3

SubscriptionsResponse listUsingGET3(appId)

Get subscriptions for an App

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
Long appId = 789L; // Long | appId
try {
    SubscriptionsResponse result = apiInstance.listUsingGET3(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#listUsingGET3");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
appId	Long	appId

Return type

SubscriptionsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

listUsingGET5

SubscriptionsResponse listUsingGET5()

Get current account's subscriptions

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
try {
    SubscriptionsResponse result = apiInstance.listUsingGET5();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#listUsingGET5");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

SubscriptionsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

sendAppReportUsingPOST1

MailReportResponse sendAppReportUsingPOST1(body, appId)

Email an App report

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
ReportInfo body = new ReportInfo(); // ReportInfo | emailDto
Long appId = 789L; // Long | appId
try {
    MailReportResponse result = apiInstance.sendAppReportUsingPOST1(body, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#sendAppReportUsingPOST1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ReportInfo	emailDto
appId	Long	appId

Return type

MailReportResponse

Authorization

api_key

HTTP request headers

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

sendDashReportUsingPOST

MailReportResponse sendDashReportUsingPOST(body, dashId)

Email a dashboard report

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
ReportInfo body = new ReportInfo(); // ReportInfo | emailDto
Long dashId = 789L; // Long | dashId
try {
    MailReportResponse result = apiInstance.sendDashReportUsingPOST(body, dashId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#sendDashReportUsingPOST");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ReportInfo	emailDto
dashId	Long	dashId

Return type

MailReportResponse

Authorization

api_key

HTTP request headers

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

toggleEnabledUsingPUT

SubscriptionResponse toggleEnabledUsingPUT(body, updateableSubscriptionId)

Toggle subscription status

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
UpdateSubscriptionDto body = new UpdateSubscriptionDto(); // UpdateSubscriptionDto | dto
Long updateableSubscriptionId = 789L; // Long | updateableSubscriptionId
try {
    SubscriptionResponse result = apiInstance.toggleEnabledUsingPUT(body, updateableSubscriptionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#toggleEnabledUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	UpdateSubscriptionDto	dto
updateableSubscriptionId	Long	updateableSubscriptionId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

updateForAppUsingPUT

SubscriptionResponse updateForAppUsingPUT(body, appId)

Update App subscription

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
SubscriptionDto body = new SubscriptionDto(); // SubscriptionDto | subscription
Long appId = 789L; // Long | appId
try {
    SubscriptionResponse result = apiInstance.updateForAppUsingPUT(body, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#updateForAppUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	SubscriptionDto	subscription
appId	Long	appId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

updateForDashUsingPUT1

SubscriptionResponse updateForDashUsingPUT1(body, dashId)

Update dashboard subscription

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

SubscriptionsApi apiInstance = new SubscriptionsApi();
SubscriptionDashboardDto body = new SubscriptionDashboardDto(); // SubscriptionDashboardDto | subscription
Long dashId = 789L; // Long | dashId
try {
    SubscriptionResponse result = apiInstance.updateForDashUsingPUT1(body, dashId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#updateForDashUsingPUT1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	SubscriptionDashboardDto	subscription
dashId	Long	dashId

Return type

SubscriptionResponse

Authorization

api_key

HTTP request headers

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

Files

SubscriptionsApi.md

Latest commit

History

SubscriptionsApi.md

File metadata and controls

SubscriptionsApi

createForAppUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

createForDashUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUsingDELETE3

Example

Parameters

Return type

Authorization

HTTP request headers

listUsingGET3

Example

Parameters

Return type

Authorization

HTTP request headers

listUsingGET5

Example

Parameters

Return type

Authorization

HTTP request headers

sendAppReportUsingPOST1

Example

Parameters

Return type

Authorization

HTTP request headers

sendDashReportUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

toggleEnabledUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

updateForAppUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

updateForDashUsingPUT1

Example

Parameters

Return type

Authorization

HTTP request headers