Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 7.12 KB

CampaignMetadataApi.md

File metadata and controls

271 lines (188 loc) · 7.12 KB

CampaignMetadataApi

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

Method HTTP request Description
campaignMetadataCreate POST /v4/api/campaign-metadata
campaignMetadataDelete DELETE /v4/api/campaign-metadata/{id}
campaignMetadataGet GET /v4/api/campaign-metadata/{id}
campaignMetadataSearch GET /v4/api/campaign-metadata
campaignMetadataUpdate PUT /v4/api/campaign-metadata/{id}

campaignMetadataCreate

CampaignMetadata campaignMetadataCreate(body)

Create a campaign metadata.

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.CampaignMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignMetadataApi apiInstance = new CampaignMetadataApi();
CampaignMetadataCreate body = new CampaignMetadataCreate(); // CampaignMetadataCreate | 
try {
    CampaignMetadata result = apiInstance.campaignMetadataCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignMetadataApi#campaignMetadataCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body CampaignMetadataCreate [optional]

Return type

CampaignMetadata

Authorization

Bearer

HTTP request headers

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

campaignMetadataDelete

campaignMetadataDelete(id)

Remove a campaign metadata.

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.CampaignMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignMetadataApi apiInstance = new CampaignMetadataApi();
String id = "id_example"; // String | 
try {
    apiInstance.campaignMetadataDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignMetadataApi#campaignMetadataDelete");
    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: Not defined

campaignMetadataGet

CampaignMetadata campaignMetadataGet(id)

Retrieve a campaign metadata.

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.CampaignMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

CampaignMetadata

Authorization

Bearer

HTTP request headers

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

campaignMetadataSearch

CampaignMetadataPaginationResponse campaignMetadataSearch(filter, query, page, perPage, sort)

Search campaign metadata.

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.CampaignMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignMetadataApi apiInstance = new CampaignMetadataApi();
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 {
    CampaignMetadataPaginationResponse result = apiInstance.campaignMetadataSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignMetadataApi#campaignMetadataSearch");
    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

CampaignMetadataPaginationResponse

Authorization

Bearer

HTTP request headers

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

campaignMetadataUpdate

CampaignMetadata campaignMetadataUpdate(id, body)

Update a campaign metadata.

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.CampaignMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


CampaignMetadataApi apiInstance = new CampaignMetadataApi();
String id = "id_example"; // String | 
CampaignMetadataUpdate body = new CampaignMetadataUpdate(); // CampaignMetadataUpdate | 
try {
    CampaignMetadata result = apiInstance.campaignMetadataUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignMetadataApi#campaignMetadataUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body CampaignMetadataUpdate [optional]

Return type

CampaignMetadata

Authorization

Bearer

HTTP request headers

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