Banking Admin Campaigns v0.5.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Manages advertising campaigns for inclusion in Apiture’s mobile and web banking applications. A campaign is an advertising effort that has a name, description/purpose, audience (list of customers), one or more different digital ads, a schedule, and a state. Campaigns start in a draft
state when created. When an admin user schedules a campaign, it’s state becomes scheduled
. When the current date/time is within one of the campaign’s scheduled periods, the campaign’s state is active
. The admin may cancel the campaign if it should stop running before the last scheduled end date. If the scheduled time frame is finished without being canceled, the campaign state becomes completed
.
Clients can create new campaigns from scratch, or they may create a copyOf
an existing campaign. Completed campaigns cannot be activated/resumed; instead, copy the campaign so that the copied campaign can collect its own metrics.
Active, canceled, and completed campaigns cannot be changed. Active campaigns must be paused before they can be edited. Completed, paused, scheduled, testing, draft, and canceled campaigns can also be archived. Archived campaigns can be restored with the unarchive operation. When completed campaigns are unarchived, they will return to the completed
state. When campaigns of any other state
are restored, they will return to the draft
state.
A campaign has one or more advertisements or ads. An ad can have specific imagery or other text content, and a redirect link (URL) that the user will be routed to when they click the ad. Copying a campaign also copies the ads in it.
Ads have a priority
which determines the order in which they are displayed to the customer. A priority
value of 1 represents the highest priority ad in a campaign. A priority
value of 100 represents the lowest priority ad in a campaign.
Ads have a location that tells the client where the application should place the ad, for example, on the account summary page of the mobile app or the payments page of the web app. A client can create a new campaign ad location based on the overall design of their application, and then create ads that display in those locations. A campaign can only have a single ad in a given location.
The API presents advertising metrics for active or completed campaigns including the number of impressions (how often ads were presented to customers), the number of click in the ads, and the number of times customers followed the ad's call to action.
Endpoints marked with a security
method of clientCredentials
are intended to be used by external applications, such as an online banking provider. These applications do not have the ability to authenticate with the Data Portal product, so an alternative authentication method is provided. These operations include dismiss, click, and getNextAd. All other endpoints marked with a security
method of accessToken
are intended to be used by the Data Portal application.
Download OpenAPI Definition (YAML)
Base URLs:
License: Apiture API License
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based client identification. See details at Secure Access.
- OpenID Connect authentication (
accessToken
)- OpenId Connect (OIDC) authentication/authorization. The client uses the
authorization_endpoint
andtoken_endpoint
to obtain an access token to pass in theAuthorization
header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access. - OIDC Configuration URL =
https://auth.apiture.com/oidc/.well-known/openid-configuration
- OpenId Connect (OIDC) authentication/authorization. The client uses the
- OAuth2 authentication (
clientCredentials
)- Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
- Flow:
clientCredentials
- Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token
Scope | Scope Description |
---|---|
bankingAdmin/read |
Read a wide variety of banking and other financial institution and customer data. |
bankingAdmin/write |
Write a wide variety of banking and other financial institution and customer data. |
Campaigns
Advertising Campaigns
listCampaigns
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaigns \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaigns HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaigns',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaigns', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaigns", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of campaigns
GET https://api.apiture.com/bankingAdmin/campaigns
Return a collection of campaigns.
Parameters
Parameter | Description |
---|---|
state in: query | array[string] Filter the response to only events whose state is in this pipe-delimited set of state names.unique items minItems: 1 maxItems: 8 pipe-delimited items: string » enum values: draft , scheduled , testing , active , paused , canceled , completed , archived |
Example responses
200 Response
{
"items": [
{
"id": "0399abed-fd3d",
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekdays"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"createdAt": "2023-07-02T10:30:43.375Z",
"updatedAt": "2023-07-02T10:30:43.375Z"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaigns |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
createCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekends"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new campaign
POST https://api.apiture.com/bankingAdmin/campaigns
Create a new advertising campaign, adding it to the the campaigns collection. The request may include an copyOf
query parameter to make a copy of an existing campaign. The state
of the new campaign is always draft
. Use scheduleCampaign
schedule the new campaign.
Body parameter
{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekends"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
}
}
Parameters
Parameter | Description |
---|---|
copyOf in: query | resourceId Make a new campaign that is a copy of an existing campaign, its campaign ads, and its audience. The parameter value is the id ({campaignId} ) of the campaign to copy. Values in the request body override those from the existing campaign, except for id , state , createdAt , createdBy , updatedAt and updatedBy which are not copied.minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
body | newCampaign (required) The data necessary to create a new campaign. |
Example responses
201 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created. | |
Schema: campaign | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. | |
Header | Location string uri-reference |
The URI of the new campaign. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getCampaign
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId} \
-H 'Accept: application/json' \
-H 'If-None-Match: string' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'If-None-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'If-None-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"If-None-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this campaign
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}
Return a representation of this campaign resource. This is a conditional operation when the If-None-Match
header is used. If the client has a campaign
response and the ETag
returned from a previous call, this operation returns a 304 Not Modified if called again when the campaign has not changed.
Parameters
Parameter | Description |
---|---|
If-None-Match in: header | string The entity tag that was returned in the ETag response header of a previous call. If the resource's current entity tag value matches this header value, the GET will return 304 (Not Modified) and no response body, else the current resource representation and updated ETag is returned.maxLength: 512 pattern: "^\\P{Cc}{1,512}$" |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaign | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
patchCampaign
Code samples
# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'If-Match: string' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string
const fetch = require('node-fetch');
const inputBody = '{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T00:00:00Z",
"endAt": "2023-08-10T00:00:00Z"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'If-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'If-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'If-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'If-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"If-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this campaign
PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId}
Perform a partial update of this campaign as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated. If a campaign state
is paused
, updating any properties other than name
and description
changes the campaign state
to draft
. This operation is only accepted whenever allows.edit
is true
.
Body parameter
{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T00:00:00Z",
"endAt": "2023-08-10T00:00:00Z"
}
}
Parameters
Parameter | Description |
---|---|
If-Match in: header | string The entity tag that was returned in the ETag response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error.maxLength: 512 pattern: "^\\P{Cc}{1,512}$" |
body | campaignPatch (required) The campaign parameters to update. |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaign | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
deleteCampaign
Code samples
# You can also use wget
curl -X DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId} \
-H 'Accept: application/problem+json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/problem+json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/problem+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/problem+json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this campaign resource
DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId}
Delete this campaign resource and any resources that are owned by it, including ads. This operation can only be called on archived
campaigns.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
400 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
"title": "Bad Request",
"status": 400,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "Input did not parse as JSON",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The operation succeeded but returned no response body. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
listCampaignHistoryRecords
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch the history records for this campaign.
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/historyRecords
Return a list of history records for this campaign.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"items": [
{
"type": "scheduled",
"occurredAt": "2023-10-10T06:00:00Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
},
{
"type": "completed",
"occurredAt": "2023-10-20T06:00:00Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignHistoryRecords |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Campaign Actions
Actions on Campaign Resources
cancelCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Cancel a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/canceled
Cancel a campaign. This changes the state
property of the campaign to canceled
. A campaign can only be canceled if the campaign state
is scheduled
, active
, or paused
. The response is the updated representation of the campaign. This operation is idempotent: no changes are made if the campaign is already canceled
. This operation is only accepted whenever allows.cancel
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to canceled . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to cancel the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
archiveCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Archive a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/archived
Archive a campaign. This changes the state
property of the campaign to archived
, as well as setting the updatedAt
and updatedBy
properties. A campaign can only be archived if the campaign state
is draft
, scheduled
, or testing
, paused
, or completed
. The response is the updated representation of the campaign. This operation is idempotent: no changes are made if the campaign is already archived. This operation is only accepted whenever allows.archive
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state property changed to archived . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to archive the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
restoreCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Unarchive a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/unarchived
Unarchive a campaign. If a campaign was completed
at the time that it was archived, restoring it will return the state to completed
. If the campaign was in any non-complete state when it was archived, then it will be set to the draft
state. The response is the updated representation of the campaign. This operation is idempotent: no changes are made if the campaign is not archived
. This operation is only accepted whenever allows.restore
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state property changed to the necessary state. | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to unarchive the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
scheduleCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Schedule a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/scheduled
Schedule a draft campaign so that it runs during its scheduled period. Draft campaigns must be scheduled for them to run. This changes the state
property of the campaign to scheduled
, unless the startAt
has passed, in which case the campaign state
is active
. A campaign can only be scheduled if the campaign state
is draft
or testing
. The response is the updated representation of the campaign. This operation is idempotent: no changes are made if the campaign is already scheduled
. This operation is only accepted whenever allows.schedule
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to canceled . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to schedule the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
resumeCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Resume a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/resumed
Resume a campaign. This changes the state
property of the campaign to active
. The response is the updated representation of the campaign. A campaign can only be resumed if the campaign state
is paused
and the current date-time is after the scheduled startAt
. If the campaign state
is paused
and the current date-time is after the scheduled endAt
, then the campaign state will have been moved to completed
and the campaign cannot be resumed. This operation is idempotent: no changes are made if the campaign is already active
. This operation is only accepted whenever allows.resume
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to active . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to resume the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
pauseCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Pause a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/paused
Pause a campaign. Ads from the campaign are not served to customers, as if the campaign were outside of its startAt
/endAt
time frame. This changes the state
property of the campaign to paused
. The response is the updated representation of the campaign. A campaign can only be paused if the campaign state
is active
. A paused
campaign is automatically moved to completed
whenever the current date-time passes the scheduled endAt
. This operation is idempotent: no changes are made if the campaign is already paused
. Use the resumeCampaign
operation to resume a paused campaign. This operation is only accepted whenever allows.pause
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to paused . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to pause the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
markCampaignAsDraft
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Mark a campaign as draft
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/draft
Mark a campaign as draft. This changes the state
property of the campaign to draft
. The response is the updated representation of the campaign. A campaign can only be set as draft if the campaign state
is scheduled
, paused
, or testing
. This operation is idempotent: no changes are made if the campaign is already draft
. This operation is only accepted whenever allows.draft
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to draft . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to draft the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
testCampaign
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Test a campaign
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/testing
Test a campaign. Ads from the campaign are served to customers from the audience with the provided testingAudience
.id
. This changes the state
property of the campaign to testing
.
The response is the updated representation of the campaign. A campaign can only be tested
if the campaign state
is draft
or scheduled
. This operation is idempotent: no changes are made if the campaign state
is already testing
. This operation is only accepted whenever allows.test
is true
.
Testing can only be entered and exited on a manual basis. An admin user must move the campaign into a testing
state and into a scheduled
or draft
state when testing is completed. Editing a campaign that is in testing
will set the campaign back to draft
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The campaign was updated and its state changed to testing . | |
Schema: campaign |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. The request to test the campaign is not allowed. | |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Campaign Ads
Ads within Advertising Campaigns
listCampaignAds
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads \
-H 'Accept: application/json' \
-H 'If-None-Match: string' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'If-None-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'If-None-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"If-None-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of ads
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads
Return a collection of ads for the given campaign.
Parameters
Parameter | Description |
---|---|
If-None-Match in: header | string The entity tag that was returned in the ETag response header of a previous call. If the resource's current entity tag value matches this header value, the GET will return 304 (Not Modified) and no response body, else the current resource representation and updated ETag is returned.maxLength: 512 pattern: "^\\P{Cc}{1,512}$" |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"items": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "6f886635-d136",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
},
{
"id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "web",
"type": "text",
"name": "overviewSide",
"label": "Overview Side",
"description": "The side bar of the web application."
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "f3e33a0d-63f2",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAds | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
createCampaignAd
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new campaign ad
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads
Create a new ad within a campaign. If the campaign's ad rotation policy is none
, the default policy is assigned. A campaign can only have a single ad in a given location. Ads cannot be added to active
, scheduled
, or completed
campaigns. If an ad is added to a paused
campaign, then the campaign state is automatically set to draft
. This operation is only accepted whenever the campaign's allows.addAd
and allows.edit
is true
.
Body parameter
{
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
Parameters
Parameter | Description |
---|---|
body | newCampaignAd (required) The data necessary to create a new ad. |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
201 Response
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates",
"imageName": "holidayPromotion.jpeg"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created. | |
Schema: campaignAd | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. | |
Header | Location string uri-reference |
The URI of the new campaign ad. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getCampaignAd
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} \
-H 'Accept: application/json' \
-H 'If-None-Match: string' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'If-None-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'If-None-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"If-None-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this ad
GET https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}
Return a representation of this ad resource.
Parameters
Parameter | Description |
---|---|
If-None-Match in: header | string The entity tag that was returned in the ETag response header of a previous call. If the resource's current entity tag value matches this header value, the GET will return 304 (Not Modified) and no response body, else the current resource representation and updated ETag is returned.maxLength: 512 pattern: "^\\P{Cc}{1,512}$" |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
adId in: path | resourceId (required) The unique identifier of this ad. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates",
"imageName": "holidayPromotion.jpeg"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAd | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such ad resource at the specified This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
patchCampaignAd
Code samples
# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'If-Match: string' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string
const fetch = require('node-fetch');
const inputBody = '{
"redirect_url": "http://example.com",
"redirectLinkLabel": "string",
"dismissible": true,
"dismiss_url": "http://example.com",
"icon": {
"visible": false
},
"priority": 1,
"location": {
"name": "home",
"Label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1,
"id": "27db0ea3-584e-4173-9ff2-77223de7b8bf",
"label": "Home"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An ad for a new CD interest rate."
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'If-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'If-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'If-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'If-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"If-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this ad
PATCH https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}
Perform a partial update of this ad as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated. Ads cannot be updated on active
, scheduled
, or completed
campaigns. If an ad is updated on a paused
campaign, then the campaign state is automatically set to draft
. This operation is only accepted whenever the campaign's allows.edit
is true
.
Body parameter
{
"redirect_url": "http://example.com",
"redirectLinkLabel": "string",
"dismissible": true,
"dismiss_url": "http://example.com",
"icon": {
"visible": false
},
"priority": 1,
"location": {
"name": "home",
"Label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1,
"id": "27db0ea3-584e-4173-9ff2-77223de7b8bf",
"label": "Home"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An ad for a new CD interest rate."
}
}
}
Parameters
Parameter | Description |
---|---|
If-Match in: header | string The entity tag that was returned in the ETag response header of a previous call. If passed, this must match the current entity tag of the resource, else the operation fails with a 412 Precondition Failed error.maxLength: 512 pattern: "^\\P{Cc}{1,512}$" |
body | campaignAdPatch (required) The ad parameters to update. |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
adId in: path | resourceId (required) The unique identifier of this ad. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates",
"imageName": "holidayPromotion.jpeg"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAd | |
Header | ETag string |
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such ad resource at the specified This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
412 | Precondition Failed |
Precondition Failed. One or more conditions given in the request header fields evaluated to false when tested on the server. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
deleteCampaignAd
Code samples
# You can also use wget
curl -X DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} \
-H 'Accept: application/problem+json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/problem+json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/problem+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/problem+json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this ad resource
DELETE https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}
Delete this ad resource and any resources that are owned by it. Ads cannot be deleted from active
, scheduled
, or completed
campaigns. If an ad is deleted from a paused
campaign, then the campaign state is automatically set to draft
. This operation is only accepted whenever the campaign's allows.edit
is true
.
Parameters
Parameter | Description |
---|---|
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
adId in: path | resourceId (required) The unique identifier of this ad. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
400 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
"title": "Bad Request",
"status": 400,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "Input did not parse as JSON",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The operation succeeded but returned no response body. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such ad resource at the specified This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
trackCampaignAdClick
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked?user=string \
-H 'Accept: application/problem+json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked?user=string HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked?user=string',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked',
method: 'post',
data: '?user=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/problem+json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked',
params: {
'user' => '[resourceId](#schema-resourceId)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/problem+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked', params={
'user': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked?user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/problem+json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Track when user has clicked an ad.
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/clicked
Indicates that user has clicked an ad. This is tracked for metrics.
Parameters
Parameter | Description |
---|---|
user in: query | resourceId (required) The ID of the banking user who has clicked the ad. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
adId in: path | resourceId (required) The unique identifier of this ad. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
400 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
"title": "Bad Request",
"status": 400,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "Input did not parse as JSON",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such ad resource at the specified This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getNextAd
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/nextCampaignAd?location=string&user=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/nextCampaignAd?location=string&user=string HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/nextCampaignAd?location=string&user=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/nextCampaignAd',
method: 'get',
data: '?location=string&user=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/nextCampaignAd',
params: {
'location' => '[resourceId](#schema-resourceId)',
'user' => '[resourceId](#schema-resourceId)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/nextCampaignAd', params={
'location': 'string', 'user': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/nextCampaignAd?location=string&user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/nextCampaignAd", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Get the next priority ad to display
GET https://api.apiture.com/bankingAdmin/nextCampaignAd
Get the next ad that the given client should display in the given location, based on the campaign with the highest priority. If no ad is available for the user in the given location, then a 204
will be returned.
Parameters
Parameter | Description |
---|---|
location in: query | resourceId (required) The location to fetch the ad for. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
user in: query | resourceId (required) The ID of the banking user to display the ad to. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates",
"imageName": "holidayPromotion.jpeg"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAd | |
204 | No Content |
No Content. The operation succeeded but returned no response body. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
listAds
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/ads \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/ads HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/ads',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/ads',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/ads',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/ads', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/ads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/ads", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of ads
GET https://api.apiture.com/bankingAdmin/ads
Return a collection of ads from all campaigns.
Parameters
Parameter | Description |
---|---|
location in: query | resourceId Filter the response to only ads whose location matches the given ID.minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"items": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "6f886635-d136",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
},
{
"id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "web",
"type": "text",
"name": "overviewSide",
"label": "Overview Side",
"description": "The side bar of the web application."
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "f3e33a0d-63f2",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAds |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Campaign Metrics
Metrics for Campaign Advertisements
listCampaignMetrics
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaignMetrics \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaignMetrics HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaignMetrics',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaignMetrics',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaignMetrics',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaignMetrics', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaignMetrics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaignMetrics", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return the summary metrics across campaigns
GET https://api.apiture.com/bankingAdmin/campaignMetrics
Return campaign metrics for all active campaigns.
Example responses
200 Response
{
"items": [
{
"campaignId": "590c0c441f3241de9526",
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignMetricsList |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Campaign Ad Locations
Display Locations for Campaign Ads
listCampaignAdLocations
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaignAdLocations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaignAdLocations HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaignAdLocations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaignAdLocations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaignAdLocations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaignAdLocations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaignAdLocations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaignAdLocations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of campaign ad locations
GET https://api.apiture.com/bankingAdmin/campaignAdLocations
Return a collection of campaign ad locations.
Example responses
200 Response
{
"items": [
{
"id": "0399abed-fd3a",
"name": "home",
"label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1
},
{
"id": "d62c0701-0d75",
"name": "overviewTop",
"label": "Overview Top",
"applicationType": "web",
"type": "text",
"description": "The top header of the overview page.",
"aspectRatio": "3:1",
"positionPriority": 2
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAdLocations |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getCampaignAdLocation
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this campaign ad location
GET https://api.apiture.com/bankingAdmin/campaignAdLocations/{campaignAdLocationId}
Return a representation of this campaign ad location resource.
Parameters
Parameter | Description |
---|---|
campaignAdLocationId in: path | resourceId (required) The unique identifier of this campaign ad location. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
200 Response
{
"name": "home",
"Label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1,
"id": "27db0ea3-584e-4173-9ff2-77223de7b8bf",
"label": "Home"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAdLocation |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 404
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Campaign Ad Dismissals
Actions to Dismiss Campaign Ads
dismissCampaignAd
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed?user=string \
-H 'Content-Type: application/json' \
-H 'Accept: application/problem+json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed?user=string HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/problem+json
const fetch = require('node-fetch');
const inputBody = '{
"reason": {
"id": "0399abed-ac23"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed?user=string',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed',
method: 'post',
data: '?user=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/problem+json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed',
params: {
'user' => '[resourceId](#schema-resourceId)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/problem+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed', params={
'user': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed?user=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/problem+json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Track when a user has dismissed an ad.
POST https://api.apiture.com/bankingAdmin/campaigns/{campaignId}/ads/{adId}/dismissed
Track when a user has dismissed an ad so that the ad will not be presented to them again.
Body parameter
{
"reason": {
"id": "0399abed-ac23"
}
}
Parameters
Parameter | Description |
---|---|
user in: query | resourceId (required) The ID of the banking user who has dismissed the ad. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
body | newCampaignAdDismissal (required) The data required to dismiss an ad. |
campaignId in: path | resourceId (required) The unique identifier of this campaign. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
adId in: path | resourceId (required) The unique identifier of this ad. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
Example responses
400 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
"title": "Bad Request",
"status": 400,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "Input did not parse as JSON",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The operation succeeded. The ad will not be returned for the user anymore. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such ad resource at the specified This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 400
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
listCampaignAdDismissalReasons
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of campaign ad dismissal reasons
GET https://api.apiture.com/bankingAdmin/campaignAdDismissalReasons
Return a collection of campaign ad dismissal reasons.
Example responses
200 Response
{
"id": "0399abed-ac23",
"name": "notRelevant",
"label": "This offer is not relevant to me"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: campaignAdDismissalReason |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
429 | Too Many Requests |
Too Many Requests. The client has sent too many requests in a given amount of time. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
4XX | Unknown |
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Status | Description |
---|---|
5XX | Unknown |
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details. | |
Schema: Inline |
Response Schema
Status Code 401
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 403
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 429
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 4XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 5XX
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" . maxLength: 2048 |
» title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type . maxLength: 120 |
» status | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048 |
» id | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30 |
» problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Schemas
apiProblem
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists at the given account_url",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
API Problem (v1.2.1)
API problem or error, as per RFC 7807 application/problem+json.
Properties
Name | Description |
---|---|
API Problem (v1.2.1) | API problem or error, as per RFC 7807 application/problem+json. |
type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" .format: uri-reference maxLength: 2048 |
title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type .format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048 |
id | The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.read-only format: date-time minLength: 20 maxLength: 30 |
problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
campaign
{
"name": "Holiday Savings Campaign",
"description": "Promote the savings account for holiday giving.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Campaign (v1.3.0)
Representation of a campaign resource. An advertising campaign with one or more advertisements.
Properties
Name | Description |
---|---|
Campaign (v1.3.0) | Representation of a campaign resource. An advertising campaign with one or more advertisements. |
name | (required) The name of this campaign. The name does not need to be unique. format: text minLength: 1 maxLength: 100 |
description | The description of this campaign, including the purpose/goals. format: text minLength: 1 maxLength: 500 |
schedule | Start date, end date, and run time intervals for an ad campaign schedule. |
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
state | (required) The state of this campaign. Update a draft campaign to scheduled via scheduleCampaign or cancelCampaign , pausedCampaign (if active), or resumeCampaign (if paused). The service automatically changes the state to active or completed at the start or end of the scheduled run period.read-only enum values: draft , scheduled , testing , active , paused , canceled , completed , archived |
allows | (required) Lists the actions the current analyst is allowed to perform on the current campaign. |
metrics | Metrics for campaigns. |
ads | array: (required) An array containing up to the first 20 campaign ads for this campaign. Within the list of customer audiences returned from listCampaigns , this list is limited to the first 20 ads. The full list is available in the full campaign response from the getCampaign .read-only maxItems: 20 items: object |
audience | Summary representation of an audience resource for a campaign. |
testingAudience | The testing audience for this campaign. This only applies when the campaign is in the testing state. |
adCount | (required) The total number of ads in a campaign. read-only format: int16 minimum: 0 maximum: 100 |
totalRuntime | The total number of days that the campaign will run based on the current schedule. This is only returned when the campaign has a defined schedule .read-only format: int16 minimum: 0 maximum: 5000 |
daysRunning | The number of days that the campaign has run. This is only returned when the campaign state is active or completed . If the campaign state is completed , this value is the total number of days that the campaign ran for. If an active campaign state is paused , then this value is reset.read-only format: int16 minimum: 0 maximum: 5000 |
createdAt | (required) The date-time when the campaign was created. read-only format: date-time minLength: 20 maxLength: 30 |
createdBy | (required) The admin user that created this campaign. |
updatedAt | The date-time when the campaign was last updated. read-only format: date-time minLength: 20 maxLength: 30 |
updatedBy | The admin user that updated this campaign. |
campaignAd
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates",
"imageName": "holidayPromotion.jpeg"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Campaign Ad (v1.3.0)
Representation of an ad, which is an in-app advertisement that can be included in a campaign.
Properties
Name | Description |
---|---|
Campaign Ad (v1.3.0) | Representation of an ad, which is an in-app advertisement that can be included in a campaign. |
redirect_url | The URL that the user is directed to whenever they click the ad. format: uri maxLength: 2048 |
redirectLinkLabel | Text that is displayed over the redirect_url. format: text maxLength: 30 |
dismissible | Boolean indicating whether the ad can be dismissed. default: true |
dismiss_url | An optional URL that is called whenever the user dismisses an ad. This can be used to collect data about ad dismissals. format: uri maxLength: 2048 |
icon | Properties that relate to an icon shown on the ad. |
priority | An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. So two ads in the same location cannot have the same priority value. If an audience is subject to multiple ads, the one with the highest priority will be shown. A value of 1 represents the highest priority, and a value of 100 represents the lowest priority.format: int16 minimum: 1 maximum: 100 |
location | The display location of the ad within the client application. |
content | The ad's localizable visual content. This object maps locales/languages to the ad content to display for customers, based on their language preference. Keys are RFC 3066 locale strings such as "en" , "fr" , "es-MX" and so on. |
» en | (required) The (default) English ad content. nullable |
» ^[a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z]{4})?)?$ | Language-specific presentation content for an ad. nullable |
id | The unique identifier for this ad resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
metrics | The metrics for this ad. |
campaign | A reference of the campaign that this ad belongs to. |
createdAt | The date-time when the ad was created. read-only format: date-time minLength: 20 maxLength: 30 |
createdBy | The admin user that created this ad. |
updatedAt | The date-time when the ad was last updated. read-only format: date-time minLength: 20 maxLength: 30 |
updatedBy | The admin user that last updated this ad. |
campaignAdApplicationType
"web"
Campaign Ad Application Type (v1.0.0)
The application type of an ad location.
campaignAdApplicationType
strings may have one of the following enumerated values:
Value | Description |
---|---|
web | Web: A web application type for an ad location |
mobile | Mobile: A mobile application type for an ad location |
type:
string
enum values: web
, mobile
campaignAdContent
{
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An ad for a new CD interest rate."
}
Campaign Ad Content (v1.1.0)
Language-specific presentation content for an ad.
Properties
Name | Description |
---|---|
Campaign Ad Content (v1.1.0) | Language-specific presentation content for an ad. nullable |
title | The title for the ad. This is a short phrase with no line breaks. format: text minLength: 1 maxLength: 80 |
body | The main text of the ad. This is Markdown text and may include lists, bold text, italics text, etc. format: markdown minLength: 1 maxLength: 400 |
imageName | The name of the uploaded image. This property is only required if the ad type is image .format: text minLength: 4 maxLength: 255 |
image | The Base64-encoded content of the ad image. This property is only required if the ad type is image format: byte maxLength: 2000000 |
contentType | The list of allowed content types for ads. enum values: text/plain , image/png , image/jpeg , image/svg |
altText | Descriptive text for the image ad. This property is only required if the ad type is image .format: text minLength: 1 maxLength: 100 |
campaignAdContentType
"text/plain"
Campaign Ad Content Type (v1.0.0)
The list of allowed content types for ads.
type:
string
enum values: text/plain
, image/png
, image/jpeg
, image/svg
campaignAdDismissalReason
{
"id": "0399abed-ac23",
"name": "notRelevant",
"label": "This offer is not relevant to me"
}
Campaign Ad Dismissal Reason (v1.0.0)
Representation of a campaign ad dismissal reason. Campaign Ad Dismissal Reasons tell why a user dismissed a campaign ad.
Properties
Name | Description |
---|---|
Campaign Ad Dismissal Reason (v1.0.0) | Representation of a campaign ad dismissal reason. Campaign Ad Dismissal Reasons tell why a user dismissed a campaign ad. |
id | (required) The unique identifier for this campaign ad dismissal reason. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The name of this campaign ad dismissal reason. format: text minLength: 2 maxLength: 100 pattern: "^[a-z][a-zA-Z0-9]{2,100}$" |
label | The label of this campaign ad dismissal reason. format: text minLength: 2 maxLength: 255 |
campaignAdDismissalReasonReference
{
"id": "0399abed-ac23",
"name": "notRelevant",
"label": "This offer is not relevant to me"
}
Campaign Ad Dismissal Reason Reference (v1.0.0)
An object that references a dismissal reason.
Properties
Name | Description |
---|---|
Campaign Ad Dismissal Reason Reference (v1.0.0) | An object that references a dismissal reason. |
id | (required) The unique identifier for this campaign ad dismissal reason. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The name of this campaign ad dismissal reason. format: text minLength: 2 maxLength: 100 pattern: "^[a-z][a-zA-Z0-9]{2,100}$" |
label | The label of this campaign ad dismissal reason. format: text minLength: 2 maxLength: 255 |
campaignAdIcon
{
"visible": false
}
Campaign Ad Icon (v1.0.0)
Properties that pertain to an icon displayed on the ad.
Properties
Name | Description |
---|---|
Campaign Ad Icon (v1.0.0) | Properties that pertain to an icon displayed on the ad. |
visible | Indicates whether an icon should be shown on the ad. default: false |
campaignAdItem
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Campaign Ad Item (v1.3.0)
Summary representation of an ad resource in a campaign. Note: In this schema, the content
only includes en
and not other locales.
Properties
Name | Description |
---|---|
Campaign Ad Item (v1.3.0) | Summary representation of an ad resource in a campaign. Note: In this schema, the content only includes en and not other locales. |
redirect_url | The URL that the user is directed to whenever they click the ad. format: uri maxLength: 2048 |
redirectLinkLabel | Text that is displayed over the redirect_url. format: text maxLength: 30 |
dismissible | Boolean indicating whether the ad can be dismissed. default: true |
dismiss_url | An optional URL that is called whenever the user dismisses an ad. This can be used to collect data about ad dismissals. format: uri maxLength: 2048 |
icon | Properties that relate to an icon shown on the ad. |
priority | An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. So two ads in the same location cannot have the same priority value. If an audience is subject to multiple ads, the one with the highest priority will be shown. A value of 1 represents the highest priority, and a value of 100 represents the lowest priority.format: int16 minimum: 1 maximum: 100 |
location | The display location of the ad within the client application. |
content | The ad's localizable visual content. This object maps locales/languages to the ad content to display for customers, based on their language preference. Keys are RFC 3066 locale strings such as "en" , "fr" , "es-MX" and so on. |
» en | (required) The (default) English ad content. nullable |
» ^[a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z]{4})?)?$ | Language-specific presentation content for an ad. nullable |
id | The unique identifier for this ad resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
metrics | The metrics for this ad. |
campaign | A reference of the campaign that this ad belongs to. |
createdAt | The date-time when the ad was created. read-only format: date-time minLength: 20 maxLength: 30 |
createdBy | The admin user that created this ad. |
updatedAt | The date-time when the ad was last updated. read-only format: date-time minLength: 20 maxLength: 30 |
updatedBy | The admin user that last updated this ad. |
campaignAdLocation
{
"name": "home",
"Label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1,
"id": "27db0ea3-584e-4173-9ff2-77223de7b8bf",
"label": "Home"
}
Campaign Ad Location (v1.0.0)
Representation of a campaign ad location resource. Campaign Ad Locations provide data about where the ad should be placed in the client application.
Properties
Name | Description |
---|---|
Campaign Ad Location (v1.0.0) | Representation of a campaign ad location resource. Campaign Ad Locations provide data about where the ad should be placed in the client application. |
name | (required) The name of this campaign ad location. This value must be unique. format: text minLength: 2 maxLength: 100 pattern: "[a-z][a-zA-Z0-9]{3,31}" |
label | (required) The label of this campaign ad location. format: text minLength: 2 maxLength: 255 |
applicationType | (required) The application type for this campaign ad location. enum values: web , mobile |
type | (required) The type of ad that this location displays. enum values: image , text |
description | (required) The description of this campaign ad location. format: text minLength: 1 maxLength: 500 |
aspectRatio | The aspect ratio for ad locations. This property only applies for ads with a type value of image . This takes the form of width:height , such as 3:1 for an ad location that is three times as wide as it is tall. For example, an image 600 pixels wide and 300 pixels tall will have an aspect ratio of 2:1 . Images are scaled to match the aspect ratio and location’s actual size, so they do not have to match the aspect ratio exactly.minLength: 3 maxLength: 9 pattern: "^[1-9](\\d){0,2}\\:[1-9](\\d){0,2}$" |
positionPriority | An integer that indicates this location's importance, relative to other locations, to allow the client to sort filter types by location importance. positionPriority is unique. So two locations cannot have the same positionPriority value. A value of 1 represents the highest priority, and a value of 100 represents the lowest priority.format: int32 minimum: 1 maximum: 100 |
id | (required) The unique identifier for this campaign ad location resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
campaignAdLocationType
"image"
Campaign Ad Location Type (v1.0.0)
The type of ad that can be placed at this location. A location can display only image
or text
ads but not both types.
campaignAdLocationType
strings may have one of the following enumerated values:
Value | Description |
---|---|
image | Image: A location for an image ad |
text | Text: A location for a text ad |
type:
string
enum values: image
, text
campaignAdLocations
{
"items": [
{
"id": "0399abed-fd3a",
"name": "home",
"label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1
},
{
"id": "d62c0701-0d75",
"name": "overviewTop",
"label": "Overview Top",
"applicationType": "web",
"type": "text",
"description": "The top header of the overview page.",
"aspectRatio": "3:1",
"positionPriority": 2
}
]
}
Campaign Ad Location Collection (v1.0.0)
Collection of campaign ad locations. The items in the collection are ordered in the items
array.
Properties
Name | Description |
---|---|
Campaign Ad Location Collection (v1.0.0) | Collection of campaign ad locations. The items in the collection are ordered in the items array. |
items | array: (required) An array containing campaign ad location items. maxItems: 1000 items: object |
campaignAdMetrics
{
"campaignId": "590c0c441f3241de9526",
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
}
Campaign Ad Metrics (v1.0.0)
Metrics for campaign ads.
Properties
Name | Description |
---|---|
Campaign Ad Metrics (v1.0.0) | Metrics for campaign ads. |
impressionCount | The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647 |
adClickCount | The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647 |
clickThroughRate | The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100 |
dismissCount | The number of times the ad was dismissed. read-only format: int32 minimum: 0 maximum: 2147483647 |
adId | The ID of the ad that these metrics pertain to. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
campaignAdPatch
{
"redirect_url": "http://example.com",
"redirectLinkLabel": "string",
"dismissible": true,
"dismiss_url": "http://example.com",
"icon": {
"visible": false
},
"priority": 1,
"location": {
"name": "home",
"Label": "Home",
"applicationType": "mobile",
"type": "image",
"description": "The home page of the mobile application.",
"aspectRatio": "6:1",
"positionPriority": 1,
"id": "27db0ea3-584e-4173-9ff2-77223de7b8bf",
"label": "Home"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An ad for a new CD interest rate."
}
}
}
Campaign Ad Patch (v1.3.0)
Request to patch a campaign ad.
Properties
Name | Description |
---|---|
Campaign Ad Patch (v1.3.0) | Request to patch a campaign ad. |
redirect_url | The URL that the user is directed to whenever they click the ad. format: uri maxLength: 2048 |
redirectLinkLabel | Text that is displayed over the redirect_url. format: text maxLength: 30 |
dismissible | Boolean indicating whether the ad can be dismissed. default: true |
dismiss_url | An optional URL that is called whenever the user dismisses an ad. This can be used to collect data about ad dismissals. format: uri maxLength: 2048 |
icon | Properties that relate to an icon shown on the ad. |
priority | An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. So two ads in the same location cannot have the same priority value. If an audience is subject to multiple ads, the one with the highest priority will be shown. A value of 1 represents the highest priority, and a value of 100 represents the lowest priority.format: int16 minimum: 1 maximum: 100 |
location | The display location of the ad within the client application. |
content | The ad's localizable visual content. This object maps locales/languages to the ad content to display for customers, based on their language preference. Keys are RFC 3066 locale strings such as "en" , "fr" , "es-MX" and so on. |
» en | (required) The (default) English ad content. nullable |
» ^[a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z]{4})?)?$ | Language-specific presentation content for an ad. nullable |
campaignAds
{
"items": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "6f886635-d136",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
},
{
"id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "web",
"type": "text",
"name": "overviewSide",
"label": "Overview Side",
"description": "The side bar of the web application."
},
"campaign": {
"id": "0399abed-fdab",
"name": "New Customers Ages 35-49",
"state": "active",
"audience": {
"id": "f3e33a0d-63f2",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
]
}
Campaign Ad Collection (v1.3.0)
Collection of ads.
Properties
Name | Description |
---|---|
Campaign Ad Collection (v1.3.0) | Collection of ads. |
items | array: An array containing ad items. maxItems: 1000 items: object |
campaignAllows
{
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": true,
"pause": true,
"cancel": true,
"archive": true,
"restore": true,
"addAd": true
}
Campaign Allows (v1.0.0)
Lists the actions the current analyst is allowed to perform on the current campaign.
Properties
Name | Description |
---|---|
Campaign Allows (v1.0.0) | Lists the actions the current analyst is allowed to perform on the current campaign. |
edit | The analyst is allowed to edit this campaign. This includes updating the name, audience, description, setting a schedule, and adding advertisements to the campaign. |
share | The analyst is allowed to share this campaign with other analysts. |
copy | The analyst is allowed to copy this campaign. |
draft | The analyst is allowed to mark this campaign as draft . This is true if the analyst is entitled to mark the campaign as draft and if the campaign state is scheduled , paused , or testing . |
schedule | The analyst is allowed to schedule this campaign. This is true if the analyst is entitled to schedule the campaign and if the campaign state is draft , paused , or testing . The campaign must also have a schedule , audience , and ads defined for this to be true . |
test | The analyst is allowed to test this campaign. This is only true if the analyst is entitled to move the campaign to testing and if the campaign state is draft or scheduled . |
resume | The analyst is allowed to resume this campaign. This is only true if the analyst is entitled to resume the campaign and if the campaign state is paused . |
pause | The analyst is allowed to pause this campaign. This is only true if the analyst is entitled to pause the campaign and if the campaign state is active . |
cancel | The analyst is allowed to cancel this campaign. This is only true if the analyst is entitled to cancel the campaign and if the campaign state is active . |
archive | The analyst is allowed to archive this campaign. This is only true if the analyst is entitled to archive the campaign and if the campaign state is completed , draft , paused , scheduled or testing . If the campaign's state is archived , this is always false . |
restore | The analyst is allowed to restore (unarchive) this campaign. If the campaign's state is not archived , this is always false . |
addAd | The analyst is allowed to create ads in this campaign. This is only true if the user is entitled to create ads and the campaign does not have the maximum number of ads. |
campaignAudienceReference
{
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
Campaign Audience Reference (v1.0.0)
An object that references a Campaign Audience by its id
and name
.
Properties
Name | Description |
---|---|
Campaign Audience Reference (v1.0.0) | An object that references a Campaign Audience by its id and name . |
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The audience name. format: text maxLength: 80 |
campaignAudienceSummary
{
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 100000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}
Campaign Audience Summary (v1.0.0)
Summary representation of an audience resource for a campaign.
Properties
Name | Description | ||||||
---|---|---|---|---|---|---|---|
Campaign Audience Summary (v1.0.0) | Summary representation of an audience resource for a campaign. | ||||||
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" | ||||||
name | (required) The audience name. format: text maxLength: 80 | ||||||
customerCount | (required) The number of customers who match the audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000 | ||||||
totalCustomerCount | (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000 | ||||||
state | (required) The state of a Customer Audience
enum values: active , archived | ||||||
customerCountUpdatedAt | (required) The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format.format: date-time minLength: 20 maxLength: 30 |
campaignHistoryRecord
{
"type": "scheduled",
"occurredAt": "2023-10-10T06:00:00Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Campaign Activity Record (v1.0.0)
Representation of a campaign history record. This response is used to see the user interactions with the campaign.
Properties
Name | Description |
---|---|
Campaign Activity Record (v1.0.0) | Representation of a campaign history record. This response is used to see the user interactions with the campaign. |
type | (required) A description of the event that was performed on the campaign. enum values: created , copiedTo , copiedFrom , draft , scheduled , testing , active , paused , canceled , completed , archived , unarchived , edited |
occurredAt | (required) The date-time when the event occurred. read-only format: date-time minLength: 20 maxLength: 30 |
updatedBy | (required) The user that updated the campaign. |
secondaryCampaignId | The ID of the related campaign associated with this action. This field is only set if type is one of copied .minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
campaignHistoryRecordType
"created"
Campaign History Record Type (v1.3.0)
The type of a campaign history record.
campaignHistoryRecordType
strings may have one of the following enumerated values:
Value | Description |
---|---|
created | Created: The campaign was created |
copiedTo | Copied: The campaign was copied to another campaign. |
copiedFrom | Copied: The campaign was copied from another campaign. |
draft | Draft: The campaign was moved to draft |
scheduled | Scheduled: The campaign was scheduled |
testing | Testing: The campaign was moved to testing |
active | Active: The campaign was activated |
paused | Paused: The campaign was paused |
canceled | Canceled: The campaign was canceled |
completed | Completed: The campaign was completed |
archived | Archived: The campaign was archived |
unarchived | Unarchived: The campaign was unarchived |
edited | Edited: The campaign was edited |
type:
string
enum values: created
, copiedTo
, copiedFrom
, draft
, scheduled
, testing
, active
, paused
, canceled
, completed
, archived
, unarchived
, edited
campaignHistoryRecords
{
"items": [
{
"type": "scheduled",
"occurredAt": "2023-10-10T06:00:00Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
},
{
"type": "completed",
"occurredAt": "2023-10-20T06:00:00Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
]
}
Campaign History Records (v1.0.0)
A list of campaign history records. This response is used to see the user interactions with the campaign.
Properties
Name | Description |
---|---|
Campaign History Records (v1.0.0) | A list of campaign history records. This response is used to see the user interactions with the campaign. |
items | array: (required) An array containing campaign history records. maxItems: 10000 items: object |
campaignInterval
{
"daysOfWeek": [
"daily"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
Campaign Interval (v1.0.0)
Day of the week and time range when an ad should be displayed.
Properties
Name | Description |
---|---|
Campaign Interval (v1.0.0) | Day of the week and time range when an ad should be displayed. |
daysOfWeek | array: (required) A list of the days of the week when the interval should apply. maxItems: 10 items: string » enum values: monday , tuesday , wednesday , thursday , friday , saturday , sunday , daily , weekdays , weekends |
startTime | (required) The time when the ad campaign is scheduled to start, in RFC 3339 UTC time format ( hh:mm:ss.sss ).format: time minLength: 7 maxLength: 12 |
endTime | (required) The time when the ad campaign is scheduled to end, in RFC 3339 UTC time format ( hh:mm:ss.sss ). This must be later than the startTime .format: time minLength: 7 maxLength: 12 |
campaignItem
{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekdays"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"id": "0399abed-fd3d",
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdAt": "2023-07-02T10:30:43.375Z",
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"updatedAt": "2023-07-02T10:30:43.375Z",
"updatedBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
}
}
Campaign Item (v1.3.0)
Summary representation of a campaign resource in a campaign collection.
Properties
Name | Description |
---|---|
Campaign Item (v1.3.0) | Summary representation of a campaign resource in a campaign collection. |
name | (required) The name of this campaign. The name does not need to be unique. format: text minLength: 1 maxLength: 100 |
description | The description of this campaign, including the purpose/goals. format: text minLength: 1 maxLength: 500 |
schedule | Start date, end date, and run time intervals for an ad campaign schedule. |
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
state | (required) The state of this campaign. Update a draft campaign to scheduled via scheduleCampaign or cancelCampaign , pausedCampaign (if active), or resumeCampaign (if paused). The service automatically changes the state to active or completed at the start or end of the scheduled run period.read-only enum values: draft , scheduled , testing , active , paused , canceled , completed , archived |
allows | (required) Lists the actions the current analyst is allowed to perform on the current campaign. |
metrics | Metrics for campaigns. |
ads | array: (required) An array containing up to the first 20 campaign ads for this campaign. Within the list of customer audiences returned from listCampaigns , this list is limited to the first 20 ads. The full list is available in the full campaign response from the getCampaign .read-only maxItems: 20 items: object |
audience | Summary representation of an audience resource for a campaign. |
testingAudience | The testing audience for this campaign. This only applies when the campaign is in the testing state. |
adCount | (required) The total number of ads in a campaign. read-only format: int16 minimum: 0 maximum: 100 |
totalRuntime | The total number of days that the campaign will run based on the current schedule. This is only returned when the campaign has a defined schedule .read-only format: int16 minimum: 0 maximum: 5000 |
daysRunning | The number of days that the campaign has run. This is only returned when the campaign state is active or completed . If the campaign state is completed , this value is the total number of days that the campaign ran for. If an active campaign state is paused , then this value is reset.read-only format: int16 minimum: 0 maximum: 5000 |
createdAt | (required) The date-time when the campaign was created. read-only format: date-time minLength: 20 maxLength: 30 |
createdBy | (required) The admin user that created this campaign. |
updatedAt | The date-time when the campaign was last updated. read-only format: date-time minLength: 20 maxLength: 30 |
updatedBy | The admin user that updated this campaign. |
campaignMetrics
{
"campaignId": "590c0c441f3241de9526",
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
}
Campaign Metrics (v1.0.0)
Metrics for campaigns.
Properties
Name | Description |
---|---|
Campaign Metrics (v1.0.0) | Metrics for campaigns. |
impressionCount | The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647 |
adClickCount | The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647 |
clickThroughRate | The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100 |
dismissCount | The number of times the ad was dismissed. read-only format: int32 minimum: 0 maximum: 2147483647 |
campaignId | The ID of the campaign that these metrics pertain to. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
campaignMetricsFields
{
"campaignId": "590c0c441f3241de9526",
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
}
Campaign Metrics Fields (v1.0.0)
Defines common campaign metrics fields. These may describe ads or campaigns.
Properties
Name | Description |
---|---|
Campaign Metrics Fields (v1.0.0) | Defines common campaign metrics fields. These may describe ads or campaigns. |
impressionCount | The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647 |
adClickCount | The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647 |
clickThroughRate | The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100 |
dismissCount | The number of times the ad was dismissed. read-only format: int32 minimum: 0 maximum: 2147483647 |
campaignMetricsList
{
"items": [
{
"campaignId": "590c0c441f3241de9526",
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
}
]
}
Campaign Metric List (v1.0.0)
A Collection of campaign metrics.
Properties
Name | Description |
---|---|
Campaign Metric List (v1.0.0) | A Collection of campaign metrics. |
items | array: (required) An array containing campaign metrics maxItems: 1000 items: object |
campaignPatch
{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T00:00:00Z",
"endAt": "2023-08-10T00:00:00Z"
}
}
Campaign Patch (v1.2.0)
Request to patch a campaign.
Properties
Name | Description |
---|---|
Campaign Patch (v1.2.0) | Request to patch a campaign. |
name | The name of this campaign. The name does not need to be unique. format: text minLength: 1 maxLength: 100 |
description | The description of this campaign, including the purpose/goals. format: text minLength: 1 maxLength: 500 |
schedule | Start date, end date, and run time intervals for an ad campaign schedule. |
audience | An object that references a Campaign Audience by its id and name . |
testingAudience | The testing audience for this campaign. This only applies when the campaign is in the testing state. When the testingAudience is updated while the campaign is in the testing state, the metrics for the campaign are reset. |
campaignReference
{
"id": "0399abed-fd3d",
"name": "Holiday Savings Campaign",
"state": "active",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
}
Campaign Reference (v1.1.0)
An object that references a summary of the campaign.
Properties
Name | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Campaign Reference (v1.1.0) | An object that references a summary of the campaign. | ||||||||||||||||||
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" | ||||||||||||||||||
name | (required) The campaign name. format: text minLength: 1 maxLength: 100 | ||||||||||||||||||
state | (required) The set of states a campaign may have.
enum values: draft , scheduled , testing , active , paused , canceled , completed , archived | ||||||||||||||||||
audience | (required) An object that references a Campaign Audience by its id and name . |
campaignSchedule
{
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-09-01T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"monday",
"tuesday",
"wednesday"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
},
{
"daysOfWeek": [
"thursday",
"friday"
],
"startTime": "11:00:00.000",
"endTime": "15:00:00.000"
}
]
}
Campaign Schedule (v1.0.0)
Start date, end date, and run time intervals for an ad campaign schedule.
Properties
Name | Description |
---|---|
Campaign Schedule (v1.0.0) | Start date, end date, and run time intervals for an ad campaign schedule. |
startAt | (required) The date-time when the ad campaign is scheduled to begin, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ).format: date-time minLength: 20 maxLength: 30 |
endAt | (required) The date-time when the ad campaign is scheduled to end, in RFC 3339 UTC date-time format ( YYYY-MM-DDThh:mm:ss.sssZ ). This must be later than the startAt .format: date-time minLength: 20 maxLength: 30 |
intervals | array: An optional list of items containing the days of the week and time ranges of when the ad should be displayed. A time range for a given day of the week cannot overlap with another time range on that same day of the week. minItems: 1 maxItems: 20 items: object |
campaignState
"draft"
Campaign States (v1.0.0)
The set of states a campaign may have.
campaignState
strings may have one of the following enumerated values:
Value | Description |
---|---|
draft | Draft: A campaign that is created but yet to be scheduled |
testing | Testing: A campaign that is running for a specific audience for the purpose of testing before it is made public. Campaigns that have finished their tests move back to a draft or scheduled state when completed. |
scheduled | Scheduled: A campaign that has been scheduled to be published on a set date but has not started running |
active | Active: A running campaign. This includes a campaign that may or may not be displayed to end users due to scheduling |
paused | Paused: An active campaign that is paused but may be resumed. No further ads are served from this campaign |
canceled | Canceled: A campaign that has been canceled before the scheduled end date of the campaign |
completed | Completed: A campaign that ran for its full schedule without being canceled |
archived | Archived: A campaign that has been archived |
type:
string
enum values: draft
, scheduled
, testing
, active
, paused
, canceled
, completed
, archived
campaigns
{
"items": [
{
"id": "0399abed-fd3d",
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"state": "active",
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"adCount": 10,
"ads": [
{
"id": "0399abed-fd3d",
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"metrics": {
"impressionCount": 432,
"adClickCount": 321,
"clickThroughRate": 25,
"dismissCount": 210
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
],
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekdays"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
},
"totalRuntime": 100,
"daysRunning": 10,
"allows": {
"edit": true,
"share": true,
"copy": true,
"draft": true,
"schedule": true,
"test": true,
"resume": false,
"pause": true,
"cancel": true,
"archive": false,
"restore": false,
"addAd": true
},
"createdBy": {
"id": "22707c1196c6f1c6938e",
"username": "MetricMagician",
"firstName": "Andy",
"lastName": "Analytics"
},
"createdAt": "2023-07-02T10:30:43.375Z",
"updatedAt": "2023-07-02T10:30:43.375Z"
}
]
}
Campaign Collection (v1.3.0)
Collection of campaigns.
Properties
Name | Description |
---|---|
Campaign Collection (v1.3.0) | Collection of campaigns. |
items | array: (required) An array containing campaign items. maxItems: 1000 items: object |
challengeFactor
{
"type": "sms",
"labels": [
"9876"
]
}
Challenge Factor (v1.2.1)
An challenge factor. See requiredIdentityChallenge
for multiple examples.
Properties
Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Challenge Factor (v1.2.1) | An challenge factor. See requiredIdentityChallenge for multiple examples. | ||||||||||||
id | The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The | ||||||||||||
type | (required) The name of challenge factor.
enum values: sms , email , voice , securityQuestions , authenticatorToken | ||||||||||||
labels | array: [ A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300 | ||||||||||||
securityQuestions | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions . |
challengeFactorId
"string"
Challenge Factor ID (v1.0.0)
The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
type:
string
minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"
challengeFactorType
"sms"
Challenge Factor Type (v1.0.0)
The name of challenge factor.
challengeFactorType
strings may have one of the following enumerated values:
Value | Description |
---|---|
sms | SMS: One-time passcode sent to the primary mobile phone number |
email | Email: One-time passcode sent to the primary email address |
voice | Voice: One-time passcode communicated via automated voice phone call |
authenticatorToken | authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app |
securityQuestions | Security Questions: Prompt with the user's security questions registered with their security profile |
type:
string
enum values: sms
, email
, voice
, securityQuestions
, authenticatorToken
challengeOperationId
"string"
Challenge Operation ID (v1.0.1)
The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
type:
string
minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"
challengePromptId
"string"
Challenge Prompt ID (v1.0.0)
The unique ID of a prompt (such as a security question) in a challenge factor.
type:
string
minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"
challengeSecurityQuestion
{
"id": "74699fa628911e762ea5",
"prompt": "What is your mother's maiden name?"
}
Challenge Security Question (v1.0.1)
A single security question within the questions
array of the challengeSecurityQuestions
Properties
Name | Description |
---|---|
Challenge Security Question (v1.0.1) | A single security question within the questions array of the challengeSecurityQuestions |
id | (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId .minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]+$" |
prompt | (required) The text prompt of this security question. format: text maxLength: 80 |
challengeSecurityQuestions
{
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
}
Challenge Security Questions (v1.0.1)
Describes a securityQuestions
challenge. This is omitted if the challenge type
is not securityQuestions
.
Properties
Name | Description |
---|---|
Challenge Security Questions (v1.0.1) | Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions . |
questions | array: (required) The array of security questions. minItems: 1 maxItems: 8 items: object |
customerAudienceState
"active"
Customer Audience State (v1.0.0)
The state of a Customer Audience
customerAudienceState
strings may have one of the following enumerated values:
Value | Description |
---|---|
active | Active: The audience is active and available for use. |
archived | Archived: The audience is archived an not available for use. Archived audiences are deleted 30 days after being archived. |
type:
string
enum values: active
, archived
customerUsername
"string"
Customer Username (v1.0.0)
A customer's login username.
type:
string(text)
format: text
maxLength: 20
dayOfWeek
"monday"
Days of Week (v1.0.0)
The day(s) of the week that an ad can run on. daily
, weekdays
, and weekends
are also accepted values. daily
will run the ad on every day of the week. weekdays
will run the ad monday
through friday
. weekends
will run the ad on saturday
and sunday
.
type:
string
enum values: monday
, tuesday
, wednesday
, thursday
, friday
, saturday
, sunday
, daily
, weekdays
, weekends
newCampaign
{
"name": "PFM Promotion",
"description": "Promote the financial institution's personal financial management module.",
"audience": {
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49",
"customerCount": 25000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
},
"testingAudience": {
"id": "0c4241de952641f3590c",
"name": "New Customers Ages 24-35",
"customerCount": 1000,
"totalCustomerCount": 50000,
"state": "active",
"customerCountUpdatedAt": "2023-04-21T08:42:01.000Z"
},
"schedule": {
"startAt": "2023-08-01T12:00:00.00Z",
"endAt": "2023-08-10T12:00:00.00Z",
"intervals": [
{
"daysOfWeek": [
"weekends"
],
"startTime": "09:00:00.000",
"endTime": "15:00:00.000"
}
]
}
}
New Campaign (v1.1.0)
Representation used to create a new campaign.
Properties
Name | Description |
---|---|
New Campaign (v1.1.0) | Representation used to create a new campaign. |
name | (required) The name of this campaign. The name does not need to be unique. format: text minLength: 1 maxLength: 100 |
description | The description of this campaign, including the purpose/goals. format: text minLength: 1 maxLength: 500 |
schedule | Start date, end date, and run time intervals for an ad campaign schedule. |
audience | An object that references a Campaign Audience by its id and name . |
testingAudience | The testing audience for this campaign. This only applies when the campaign is in the testing state. When the testingAudience is updated while the campaign is in the testing state, the metrics for the campaign are reset. |
newCampaignAd
{
"redirect_url": "http://cdn.example.com/links/banking-ad",
"redirectLinkLabel": "Learn More",
"dismissible": true,
"dismiss_url": "http://cdn.example.com/links/dismiss-link",
"priority": 1,
"icon": {
"visible": true
},
"location": {
"id": "0399abed-ac23",
"applicationType": "mobile",
"type": "image",
"name": "home",
"label": "Home",
"description": "The home page of the mobile application"
},
"content": {
"en": {
"title": "Save for the Holidays!",
"body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
"imageName": "holidayPromotion.jpeg",
"image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
"contentType": "image/jpeg",
"altText": "An advertisement for new banking CD rates"
}
}
}
New Campaign Ad (v1.2.0)
Representation used to create a new campaign ad.
Properties
Name | Description |
---|---|
New Campaign Ad (v1.2.0) | Representation used to create a new campaign ad. |
redirect_url | (required) The URL that the user is directed to whenever they click the ad. format: uri maxLength: 2048 |
redirectLinkLabel | Text that is displayed over the redirect_url. format: text maxLength: 30 |
dismissible | (required) Boolean indicating whether the ad can be dismissed. default: true |
dismiss_url | An optional URL that is called whenever the user dismisses an ad. This can be used to collect data about ad dismissals. format: uri maxLength: 2048 |
icon | Properties that relate to an icon shown on the ad. |
priority | An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. So two ads in the same location cannot have the same priority value. If an audience is subject to multiple ads, the one with the highest priority will be shown. A value of 1 represents the highest priority, and a value of 100 represents the lowest priority.format: int16 minimum: 1 maximum: 100 |
location | (required) The display location of the ad within the client application. |
content | (required) The ad's localizable visual content. This object maps locales/languages to the ad content to display for customers, based on their language preference. Keys are RFC 3066 locale strings such as "en" , "fr" , "es-MX" and so on. |
» en | (required) The (default) English ad content. nullable |
» ^[a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z]{4})?)?$ | Language-specific presentation content for an ad. nullable |
newCampaignAdDismissal
{
"reason": {
"id": "0399abed-ac23"
}
}
New Campaign Ad Dismissal (v1.0.0)
A request to dismiss a campaign ad.
Properties
Name | Description |
---|---|
New Campaign Ad Dismissal (v1.0.0) | A request to dismiss a campaign ad. |
reason | An object that references a dismissal reason. |
problemResponse
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
"title": "Account Not Found",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No account exists for the given account reference",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Problem Response (v0.4.1)
API problem or error response, as per RFC 9457 application/problem+json.
Properties
Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
type | A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank" .format: uri-reference maxLength: 2048 |
title | A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type .format: text maxLength: 120 |
status | The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599 |
detail | A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256 |
instance | A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048 |
id | The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
occurredAt | The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.read-only format: date-time minLength: 20 maxLength: 30 |
problems | array: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object |
attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
readOnlyResourceId
"string"
Read-only Resource Identifier (v1.0.1)
The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
type:
string
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
readOnlyTimestamp
"2021-10-30T19:06:04.250Z"
Read-Only Timestamp (v1.0.0)
A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time
UTC format: YYYY-MM-DDThh:mm:ss.sssZ
.
type:
string(date-time)
read-only
format: date-time
minLength: 20
maxLength: 30
requiredIdentityChallenge
{
"operationId": "createTransfer",
"challengeId": "0504076c566a3cf7009c",
"factors": [
{
"type": "sms",
"labels": [
"9876"
],
"id": "85c0ee5753fcd0b0953f"
},
{
"type": "voice",
"labels": [
"9876"
],
"id": "d089e10a80a8627df37b"
},
{
"type": "voice",
"labels": [
"6754"
],
"id": "10506ecf9d1c2ee00403"
},
{
"type": "email",
"labels": [
"an****nk@example.com",
"an****98@example.com"
],
"id": "e917d671cb2f030b56f1"
},
{
"type": "authenticatorToken",
"labels": [
"Acme fob"
],
"id": "fe6c452d7da0bbb4e407"
},
{
"type": "securityQuestions",
"securityQuestions": {
"questions": [
{
"id": "q1",
"prompt": "What is your mother's maiden name?"
},
{
"id": "q4",
"prompt": "What is your high school's name?"
},
{
"id": "q9",
"prompt": "What is the name of your first pet?"
}
]
},
"id": "df33c6f88a37d6b3f0a6"
}
]
}
Required Challenge (v1.2.3)
A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired
. See the "Challenge API" for details.
Properties
Name | Description |
---|---|
Required Challenge (v1.2.3) | A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired . See the "Challenge API" for details. |
operationId | (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{6,48}$" |
challengeId | (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
factors | array: (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor.minItems: 1 maxItems: 8 items: object |
resourceId
"string"
Resource Identifier (v1.0.1)
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
type:
string
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
testingCampaignAudienceReference
{
"id": "590c0c441f3241de9526",
"name": "New Customers Ages 35-49"
}
Testing Campaign Audience Reference (v1.0.0)
The testing audience for this campaign. This only applies when the campaign is in the testing
state. When the testingAudience is updated while the campaign is in the testing
state, the metrics for the campaign are reset.
Properties
Name | Description |
---|---|
Testing Campaign Audience Reference (v1.0.0) | The testing audience for this campaign. This only applies when the campaign is in the testing state. When the testingAudience is updated while the campaign is in the testing state, the metrics for the campaign are reset. |
id | (required) The unique identifier for this campaign resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
name | The audience name. format: text maxLength: 80 |
timestamp
"2021-10-30T19:06:04.250Z"
Timestamp (v1.0.0)
A timestamp (an instant in time) formatted in YYYY-MM-DDThh:mm:ss.sssZ
RFC 3339 date-time
UTC format.
type:
string(date-time)
format: date-time
minLength: 20
maxLength: 30
userAccountReference
{
"id": "0399abed-fd3d",
"firstName": "Benny",
"lastName": "Billings",
"username": "bbillings"
}
User Account Reference (v1.0.2)
The representation of a user account.
Properties
Name | Description |
---|---|
User Account Reference (v1.0.2) | The representation of a user account. |
id | (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$" |
firstName | (required) The user's first name. format: text maxLength: 56 |
lastName | (required) The user's last name. format: text maxLength: 56 |
username | (required) The user's login name. format: text maxLength: 20 |
@apiture/api-doc
3.2.1 on Wed Apr 10 2024 15:36:15 GMT+0000 (Coordinated Universal Time).