Skip to content

WidgetApi.md

Latest commit

 

History

History
319 lines (221 loc) · 7.37 KB

WidgetApi.md

File metadata and controls

319 lines (221 loc) · 7.37 KB
Raw

WidgetApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
getV4ApiWidgetsCampaigns GET /v4/api/widgets/campaigns/{accountId}
postV4ApiWidgetSearch POST /v4/api/widget
widgetDelete DELETE /v4/api/widget/{id}
widgetGet GET /v4/api/widget/{id}
widgetSearch GET /v4/api/widget
widgetUpdate PUT /v4/api/widget/{id}

getV4ApiWidgetsCampaigns

getV4ApiWidgetsCampaigns(accountId)

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
String accountId = "accountId_example"; // String | 
try {
    apiInstance.getV4ApiWidgetsCampaigns(accountId);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#getV4ApiWidgetsCampaigns");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
accountId String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

postV4ApiWidgetSearch

Widget postV4ApiWidgetSearch(body)

Create a widget.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
WidgetCreate body = new WidgetCreate(); // WidgetCreate | 
try {
    Widget result = apiInstance.postV4ApiWidgetSearch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#postV4ApiWidgetSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body WidgetCreate [optional]

Return type

Widget

Authorization

Bearer

HTTP request headers

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

widgetDelete

widgetDelete(id)

Remove a widget.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
String id = "id_example"; // String | 
try {
    apiInstance.widgetDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#widgetDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

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

widgetGet

Widget widgetGet(id)

Retrieve a widget.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
String id = "id_example"; // String | 
try {
    Widget result = apiInstance.widgetGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#widgetGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

Widget

Authorization

Bearer

HTTP request headers

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

widgetSearch

WidgetPaginationResponse widgetSearch(filter, query, page, perPage, sort)

Search widgets.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    WidgetPaginationResponse result = apiInstance.widgetSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#widgetSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

WidgetPaginationResponse

Authorization

Bearer

HTTP request headers

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

widgetUpdate

Widget widgetUpdate(id, body)

Update a widget.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.WidgetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetApi apiInstance = new WidgetApi();
String id = "id_example"; // String | 
WidgetUpdate body = new WidgetUpdate(); // WidgetUpdate | 
try {
    Widget result = apiInstance.widgetUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetApi#widgetUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body WidgetUpdate [optional]

Return type

Widget

Authorization

Bearer

HTTP request headers

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