Service Campaigns v0.29.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.

API Identities

This API is designed to be called from the following identity types:

• Secure service client

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/service

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• 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.
adminData/read	Read access to non-banking data and resources.
adminData/write	Read, write, and delete access to non-banking data and resources.
samlPlatform/write	Write access to security-critical Apiture internal key and certificate data.
samlPlatform/read	Read access to integration resources, e.g. supported codes.
samlAdmin/write	Write, delete and execute access to service provider metadata and SAML computation operations.
systemIntegrations/read	Read access to integration definition resources.
systemIntegrations/write	Write, delete and execute access to integration definition resources.

Campaigns

Advertising Campaigns

listCampaigns

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/campaigns \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/campaigns', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/campaigns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of campaigns

GET https://api.apiture.com/service/campaigns

Return a collection of campaigns.

Parameters

Parameter	Description
q in: query	string(text) Optional search string. This search is case insensitive and will return campaigns where any part of the name or description matches the search string. See "Using Search Strings" in the Admin Search API for details on searching for multiple words. format: text minLength: 1 maxLength: 1000
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
audience in: query	resourceId Return campaigns whose audience.id equals the given audience value. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

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",
        "state": "active",
        "customerCount": 12340,
        "totalCustomerCount": 2340659,
        "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",
              "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
              "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"
          }
        ]
      },
      "daysRunning": 10,
      "createdBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      },
      "createdAt": "2023-07-02T10:30:43.375Z",
      "updatedAt": "2023-07-02T10:30:43.375Z",
      "metricsResetAt": "2023-07-02T10:30:43.375Z"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaigns/{campaignId} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/campaigns/{campaignId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/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':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/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' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/campaigns/{campaignId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/campaigns/{campaignId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/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/service/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	entityTag 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. minLength: 3 maxLength: 512 pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"
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}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

Example responses

200 Response

{
  "name": "Holiday Savings Campaign",
  "description": "Promote the savings account for holiday giving.",
  "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",
  "audience": {
    "id": "590c0c441f3241de9526",
    "name": "New Customers Ages 35-49",
    "state": "active",
    "customerCount": 12340,
    "retailCustomerCount": 10000,
    "commercialCustomerCount": 2340,
    "enrolledCustomerCount": 12300,
    "unenrolledCustomerCount": 40,
    "applicantCount": 100,
    "totalCustomerCount": 2340659,
    "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
  },
  "metrics": {
    "impressionCount": 432,
    "adClickCount": 321,
    "clickThroughRate": 25,
    "dismissCount": 210
  },
  "daysRunning": 10,
  "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"
  },
  "metricsResetAt": "2023-07-02T10:30:43.375Z"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaigns/{campaignId}/historyRecords \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/campaigns/{campaignId}/historyRecords', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/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/service/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}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

Example responses

200 Response

{
  "items": [
    {
      "type": "scheduled",
      "state": "scheduled",
      "occurredAt": "2023-10-10T06:00:00Z",
      "updatedBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      }
    },
    {
      "type": "completed",
      "state": "completed",
      "occurredAt": "2023-10-20T06:00:00Z",
      "updatedBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listCampaignCustomerEngagement

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/service/campaigns/{campaignId}/customerEngagement \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/campaigns/{campaignId}/customerEngagement 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/service/campaigns/{campaignId}/customerEngagement',
{
  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/service/campaigns/{campaignId}/customerEngagement',
  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/service/campaigns/{campaignId}/customerEngagement',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/campaigns/{campaignId}/customerEngagement', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/campaigns/{campaignId}/customerEngagement");
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/service/campaigns/{campaignId}/customerEngagement", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a page of customer engagement data for an active, paused, or completed campaign.

GET https://api.apiture.com/service/campaigns/{campaignId}/customerEngagement

Return a page of customer IDs for this campaign. This is the resource IDs of banking customers from the campaign's customer audience. There can be many thousands or even millions of customers, so the client must fetch these via pagination with a maximum limit of 100,000 customers per page. The campaign's customer audience resource indicates how many customers satisfy the audience filter criteria. For each customer ID, the API will return a boolean that indicates whether a customer viewed, clicked, and/or dismissed any ad in the campaign. This operation can only be performed on campaigns with a state of active, paused, or completed.

Parameters

Parameter	Description
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 100000 default: 10000
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}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

Example responses

200 Response

{
  "start": "74f96e77c3aafcb9fe85",
  "limit": 100000,
  "count": 189,
  "items": [
    {
      "customerId": "8afb049f5672424d7b3a",
      "dataCustomerId": "8cac1a147f0f82cd0bee",
      "primaryPhoneNumber": "+19992345678",
      "primaryEmail": "email@example.com",
      "viewed": true,
      "clicked": true,
      "dismissed": true
    },
    {
      "customerId": "a26c043c527f42430b14",
      "dataCustomerId": "9f9c2a13b22a496aae0e",
      "primaryPhoneNumber": "+11112345678",
      "primaryEmail": "api@example.com",
      "viewed": true,
      "clicked": false,
      "dismissed": false
    }
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/campaigns/08c8fdf03607d0e12c92/customerEngagement?start=74f96e77c3aafcb9fe85&limit=100000"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaigns/{campaignId}/ads \
  -H 'Accept: application/json' \
  -H 'If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/campaigns/{campaignId}/ads HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/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':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/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' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/campaigns/{campaignId}/ads',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/campaigns/{campaignId}/ads', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/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/service/campaigns/{campaignId}/ads

Return a collection of ads for the given campaign.

Parameters

Parameter	Description
If-None-Match in: header	entityTag 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. minLength: 3 maxLength: 512 pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"
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}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

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",
          "name": "New Customers Ages 35-49"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "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",
          "name": "Northeast US Customers"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "contentType": "image/jpeg",
          "altText": "An advertisement for new banking CD rates"
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaigns/{campaignId}/ads/{adId} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/campaigns/{campaignId}/ads/{adId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/service/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':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/service/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' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/service/campaigns/{campaignId}/ads/{adId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/service/campaigns/{campaignId}/ads/{adId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/service/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/service/campaigns/{campaignId}/ads/{adId}

Return a representation of this ad resource.

Parameters

Parameter	Description
If-None-Match in: header	entityTag 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. minLength: 3 maxLength: 512 pattern: "^((\\\"?[\\x21\\x23-\\x7e]{1,512}\\\"?)|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"
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}$"
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

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
  },
  "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",
      "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
      "contentType": "image/jpeg",
      "altText": "An advertisement for new banking CD rates"
    }
  }
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/ads \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/ads', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/ads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of ads

GET https://api.apiture.com/service/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}$"
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
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

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",
          "name": "New Customers Ages 35-49"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "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",
          "name": "Northeast US Customers"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "contentType": "image/jpeg",
          "altText": "An advertisement for new banking CD rates"
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaignMetrics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/campaignMetrics', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/campaignMetrics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return the summary metrics across campaigns

GET https://api.apiture.com/service/campaignMetrics

Return campaign metrics for all active campaigns.

Parameters

Parameter	Description
institutions in: query	array[string] An identifier that uniquely identifies a financial institution. This can be used to fetch resources for a particular institution. This is only allowed for Apiture administrative users, and cannot be used by admins at an institution. minItems: 1 maxItems: 1 pipe-delimited items: string » minLength: 2 » maxLength: 8 » pattern: "^[A-Z0-9_]{2,8}$"

Example responses

200 Response

{
  "items": [
    {
      "campaignId": "590c0c441f3241de9526",
      "impressionCount": 432,
      "adClickCount": 321,
      "clickThroughRate": 25,
      "dismissCount": 210
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaignAdLocations \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/campaignAdLocations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/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/service/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

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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/service/campaignAdLocations/{campaignAdLocationId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/service/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/service/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/service/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/service/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/service/campaignAdLocations/{campaignAdLocationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/service/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/service/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/service/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"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) 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	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object 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)	object API problem or error, as per RFC 7807 application/problem+json.
type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) 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	readOnlyResourceId 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	readOnlyTimestamp(date-time) 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: [apiProblem] 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.",
  "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",
  "audience": {
    "id": "590c0c441f3241de9526",
    "name": "New Customers Ages 35-49",
    "state": "active",
    "customerCount": 12340,
    "retailCustomerCount": 10000,
    "commercialCustomerCount": 2340,
    "enrolledCustomerCount": 12300,
    "unenrolledCustomerCount": 40,
    "applicantCount": 100,
    "totalCustomerCount": 2340659,
    "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
  },
  "metrics": {
    "impressionCount": 432,
    "adClickCount": 321,
    "clickThroughRate": 25,
    "dismissCount": 210
  },
  "daysRunning": 10,
  "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"
  },
  "metricsResetAt": "2023-07-02T10:30:43.375Z"
}

Campaign (v2.5.0)

Representation of a campaign resource. An advertising campaign with one or more advertisements.

Properties

Name	Description
Campaign (v2.5.0)	object Representation of a campaign resource. An advertising campaign with one or more advertisements.
name	string(text) (required) The name of this campaign. The name does not need to be unique. format: text minLength: 3 maxLength: 100
description	string(text) The description of this campaign, including the purpose/goals. format: text minLength: 3 maxLength: 500
schedule	campaignSchedule Start date, end date, and run time intervals for an ad campaign schedule.
id	resourceId (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	campaignState (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
metrics	campaignMetrics Metrics for campaigns.
ads	array: [campaignAd] 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
adCount	integer(int16) The total number of ads in a campaign. read-only format: int16 minimum: 0 maximum: 100
daysRunning	integer(int16) The number of days that the campaign has run. This is only returned when the campaign state is active, paused, or completed. If the campaign state is active or paused, then this value represents the number of days that the campaign has run so far. When a campaign is paused or resumed, then this value is incremented if the campaign was run at any point during the day the action occurred. If the campaign state is completed, this value represents the total number of days that the campaign ran. read-only format: int16 minimum: 0 maximum: 5000
createdAt	readOnlyTimestamp(date-time) (required) The date-time when the campaign was created. read-only format: date-time minLength: 20 maxLength: 30
createdBy	userAccountReference (required) The admin user that created this campaign.
updatedAt	readOnlyTimestamp(date-time) The date-time when the campaign was last updated. read-only format: date-time minLength: 20 maxLength: 30
updatedBy	userAccountReference The admin user that updated this campaign.
metricsResetAt	readOnlyTimestamp(date-time) The date-time when the campaign metrics were last reset. read-only format: date-time minLength: 20 maxLength: 30
audience	campaignAudienceSummaryWithCounts Summary representation of an audience resource for a campaign with all count properties. Unevaluated Properties: false
testingAudience	campaignAudienceSummaryWithCounts The testing audience for this campaign. This only applies when the campaign is in the testing state. Unevaluated Properties: false

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
  },
  "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",
      "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
      "contentType": "image/jpeg",
      "altText": "An advertisement for new banking CD rates"
    }
  }
}

Campaign Ad (v1.8.0)

Representation of an ad, which is an in-app advertisement that can be included in a campaign.

Properties

Name	Description
Campaign Ad (v1.8.0)	object Representation of an ad, which is an in-app advertisement that can be included in a campaign.
redirect_url	string(uri-reference) The URL that the user is directed to whenever they click the ad. format: uri-reference maxLength: 2048
redirectLinkLabel	string(text) Text that is displayed over the redirect_url. format: text maxLength: 30
dismissible	boolean Boolean indicating whether the ad can be dismissed.
dismiss_url	string(uri) 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	campaignAdIcon Properties that relate to an icon shown on the ad.
priority	integer(int16) An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. 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	campaignAdLocationReference The display location of the ad within the client application. Unevaluated Properties: false
content	campaignAdLocalizedContent 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.
id	resourceId 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	campaignAdMetrics The metrics for this ad.
campaign	campaignReference A reference of the campaign that this ad belongs to.
createdAt	readOnlyTimestamp(date-time) The date-time when the ad was created. read-only format: date-time minLength: 20 maxLength: 30
createdBy	userAccountReference The admin user that created this ad.
updatedAt	readOnlyTimestamp(date-time) The date-time when the ad was last updated. read-only format: date-time minLength: 20 maxLength: 30
updatedBy	userAccountReference 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",
  "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
  "contentType": "image/jpeg",
  "altText": "An ad for a new CD interest rate."
}

Campaign Ad Content (v1.2.0)

Language-specific presentation content for an ad.

Properties

Name	Description
Campaign Ad Content (v1.2.0)	object | null Language-specific presentation content for an ad. nullable
title	string(text) The title for the ad. This is a short phrase with no line breaks. format: text minLength: 1 maxLength: 80
body	string(markdown) 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	string(text) The name of the uploaded image. This property is only required if the ad type is image. format: text minLength: 4 maxLength: 255
image	string(byte) The Base64-encoded content of the ad image. This property is only required if the ad type is image format: byte maxLength: 2000000
thumbnail_url	string(uri) The URL where the thumbnail is located. This property only applies for ads with a type value of image. This must be publicly accessible without authentication. format: uri maxLength: 400
contentType	campaignAdContentType The list of allowed content types for ads. enum values: text/plain, image/png, image/jpeg, image/svg, image/unknown
altText	string(text) 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, image/unknown

campaignAdDismissalReason

{
  "id": "0399abed-ac23",
  "name": "notRelevant",
  "label": "This offer is not relevant to me"
}

Campaign Ad Dismissal Reason (v1.1.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.1.0)	object Representation of a campaign ad dismissal reason. Campaign Ad Dismissal Reasons tell why a user dismissed a campaign ad.
id	resourceId (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	string(text) The name of this campaign ad dismissal reason. format: text minLength: 3 maxLength: 100 pattern: "^[a-z][a-zA-Z0-9]{2,99}$"
label	string(text) The label of this campaign ad dismissal reason. format: text minLength: 2 maxLength: 255

campaignAdDismissalReasons

{
  "items": [
    {
      "id": "0399abed-ac23",
      "name": "notRelevant",
      "label": "This offer is not relevant to me"
    },
    {
      "id": "d25ed4ea-228e",
      "name": "betterOffers",
      "label": "I have better offers from other sources"
    }
  ]
}

Campaign Ad Dismissal Reason Collection (v1.0.0)

Collection of campaign ad dismissal reasons. The items in the collection are ordered in the items array.

Properties

Name	Description
Campaign Ad Dismissal Reason Collection (v1.0.0)	object Collection of campaign ad dismissal reasons. The items in the collection are ordered in the items array.
items	array: [campaignAdDismissalReason] (required) An array containing campaign ad dismissal reason items. maxItems: 1000 items: object

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)	object Properties that pertain to an icon displayed on the ad.
visible	boolean 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",
      "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
      "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.8.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.8.0)	object Summary representation of an ad resource in a campaign. Note: In this schema, the content only includes en and not other locales. Unevaluated Properties: false
redirect_url	string(uri-reference) The URL that the user is directed to whenever they click the ad. format: uri-reference maxLength: 2048
redirectLinkLabel	string(text) Text that is displayed over the redirect_url. format: text maxLength: 30
dismissible	boolean Boolean indicating whether the ad can be dismissed.
dismiss_url	string(uri) 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	campaignAdIcon Properties that relate to an icon shown on the ad.
priority	integer(int16) An integer value that determines when the ad will be displayed over another ad. Ad priority is unique within an ad location. 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	campaignAdLocationReference The display location of the ad within the client application. Unevaluated Properties: false
content	campaignAdLocalizedContent 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.
id	resourceId 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	campaignAdMetrics The metrics for this ad.
campaign	campaignReference A reference of the campaign that this ad belongs to.
createdAt	readOnlyTimestamp(date-time) The date-time when the ad was created. read-only format: date-time minLength: 20 maxLength: 30
createdBy	userAccountReference The admin user that created this ad.
updatedAt	readOnlyTimestamp(date-time) The date-time when the ad was last updated. read-only format: date-time minLength: 20 maxLength: 30
updatedBy	userAccountReference The admin user that last updated this ad.

campaignAdLocalizedContent

{
  "en": {
    "title": "Save for the Holidays!",
    "body": "Open a Holiday Savings Account today so you are prepared for holiday giving.",
    "image": "QmFzZTY0IGVuY29kZWQgaW1hZ2UgY29udGVudCBoZXJlLi4u",
    "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
    "contentType": "image/jpeg",
    "altText": "An ad for a new CD interest rate."
  }
}

Campaign Ad Localized Content (v1.0.0)

Campaign Ad Localized Content.

Properties

Name	Description
Campaign Ad Localized Content (v1.0.0)	object Campaign Ad Localized Content.
en	campaignAdContent | null (required) The (default) English ad content. nullable
^[a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z]{4})?)?$	campaignAdContent | null Language-specific presentation content for an ad. nullable

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"
}

Campaign Ad Location (v1.1.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.1.0)	object Representation of a campaign ad location resource. Campaign Ad Locations provide data about where the ad should be placed in the client application.
name	campaignAdLocationName(text) (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]{1,99}"
label	string(text) (required) The label of this campaign ad location. format: text minLength: 2 maxLength: 255
applicationType	campaignAdApplicationType (required) The application type for this campaign ad location. enum values: web, mobile
type	campaignAdLocationType (required) The type of ad that this location displays. enum values: image, text
description	string(text) (required) The description of this campaign ad location. format: text minLength: 1 maxLength: 500
aspectRatio	string 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	integer(int32) 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	resourceId (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}$"

campaignAdLocationName

"string"

Campaign Ad Location Name (v1.0.0)

The name of a campaign ad location.

type: string(text)

format: text
minLength: 2
maxLength: 100
pattern: "[a-z][a-zA-Z0-9]{1,99}"

campaignAdLocationReference

{
  "name": "home",
  "label": "Home",
  "applicationType": "mobile",
  "type": "image",
  "description": "The home page of the mobile application.",
  "aspectRatio": "6:1",
  "positionPriority": 100,
  "id": "27db0ea3-584e-4173-9ff2-77223de7b8bf"
}

Campaign Ad Location Reference (v1.0.0)

An object that references a campaign ad location by its id.

Properties

Name	Description
Campaign Ad Location Reference (v1.0.0)	object An object that references a campaign ad location by its id. Unevaluated Properties: false
name	campaignAdLocationName(text) 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]{1,99}"
label	string(text) The label of this campaign ad location. format: text minLength: 2 maxLength: 255
applicationType	campaignAdApplicationType The application type for this campaign ad location. enum values: web, mobile
type	campaignAdLocationType The type of ad that this location displays. enum values: image, text
description	string(text) The description of this campaign ad location. format: text minLength: 1 maxLength: 500
aspectRatio	string 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	integer(int32) 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	resourceId (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.1.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.1.0)	object Collection of campaign ad locations. The items in the collection are ordered in the items array.
items	array: [campaignAdLocation] (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)	object Metrics for campaign ads.
impressionCount	integer(int32) The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647
adClickCount	integer(int32) The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647
clickThroughRate	number(float) The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100
dismissCount	integer(int32) The number of times the ad was dismissed. read-only format: int32 minimum: 0 maximum: 2147483647
adId	readOnlyResourceId The ID of the ad that these metrics pertain to. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

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",
          "name": "New Customers Ages 35-49"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "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",
          "name": "Northeast US Customers"
        }
      },
      "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "contentType": "image/jpeg",
          "altText": "An advertisement for new banking CD rates"
        }
      }
    }
  ]
}

Campaign Ad Collection (v1.8.0)

Collection of ads.

Properties

Name	Description
Campaign Ad Collection (v1.8.0)	object Collection of ads.
items	array: [campaignAdItem] An array containing ad items. maxItems: 1000 items: object » Unevaluated Properties: false

campaignAudienceReference

{
  "id": "590c0c441f3241de9526",
  "name": "New Customers Ages 35-49"
}

Campaign Audience Reference (v1.1.0)

An object that references a Campaign Audience by its id and name.

Properties

Name	Description
Campaign Audience Reference (v1.1.0)	object An object that references a Campaign Audience by its id and name. Unevaluated Properties: false
id	resourceId (required) The unique identifier for this campaign audience resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) The audience name. format: text maxLength: 100

campaignAudienceSummary

{
  "id": "590c0c441f3241de9526",
  "name": "New Customers Ages 35-49",
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "state": "active",
  "customerCount": 12340,
  "totalCustomerCount": 2340659
}

Campaign Audience Summary (v1.1.0)

Summary representation of an audience resource for a campaign.

Properties

Name	Description
Campaign Audience Summary (v1.1.0)	object Summary representation of an audience resource for a campaign. Unevaluated Properties: false
id	resourceId (required) The unique identifier for this campaign audience resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The audience name. format: text maxLength: 100
customerCountUpdatedAt	timestamp(date-time) (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
state	customerAudienceState (required) 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 and not available for use. Archived audiences are deleted 30 days after being archived. enum values: active, archived
customerCount	integer(int32) (required) The number of customers who match the audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000

campaignAudienceSummaryWithCounts

{
  "id": "590c0c441f3241de9526",
  "name": "New Customers Ages 35-49",
  "customerCount": 12340,
  "retailCustomerCount": 10000,
  "commercialCustomerCount": 2340,
  "enrolledCustomerCount": 12300,
  "unenrolledCustomerCount": 40,
  "applicantCount": 100,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "state": "active"
}

Campaign Audience Summary With Counts (v1.0.0)

Summary representation of an audience resource for a campaign with all count properties.

Properties

Name	Description
Campaign Audience Summary With Counts (v1.0.0)	object Summary representation of an audience resource for a campaign with all count properties. Unevaluated Properties: false
id	resourceId (required) The unique identifier for this campaign audience resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The audience name. format: text maxLength: 100
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
retailCustomerCount	integer(int32) The number of retail customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
commercialCustomerCount	integer(int32) The number of commercial customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
enrolledCustomerCount	integer(int32) The number of customers who are enrolled in online banking and match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
unenrolledCustomerCount	integer(int32) The number of customers who are not enrolled in online banking and match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
applicantCount	integer(int32) The number of digital banking applicants who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000
customerCountUpdatedAt	timestamp(date-time) (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
state	customerAudienceState (required) 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 and not available for use. Archived audiences are deleted 30 days after being archived. enum values: active, archived

campaignCustomerEngagement

{
  "start": "74f96e77c3aafcb9fe85",
  "limit": 100000,
  "count": 189,
  "items": [
    {
      "customerId": "8afb049f5672424d7b3a",
      "dataCustomerId": "8cac1a147f0f82cd0bee",
      "primaryPhoneNumber": "+19992345678",
      "primaryEmail": "email@example.com",
      "viewed": true,
      "clicked": true,
      "dismissed": true
    },
    {
      "customerId": "a26c043c527f42430b14",
      "dataCustomerId": "9f9c2a13b22a496aae0e",
      "primaryPhoneNumber": "+11112345678",
      "primaryEmail": "api@example.com",
      "viewed": true,
      "clicked": false,
      "dismissed": false
    }
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/campaigns/08c8fdf03607d0e12c92/customerEngagement?start=74f96e77c3aafcb9fe85&limit=100000"
}

Campaign Customer Engagement (v1.2.0)

A page of customer engagement data for a completed campaign.

Properties

Name	Description
Campaign Customer Engagement (v1.2.0)	object A page of customer engagement data for a completed campaign. Unevaluated Properties: false
items	array: [campaignCustomerEngagementItem] (required) The array of customer engagement data. maxItems: 100000 items: object » Unevaluated Properties: false
start	string(text) The opaque cursor that specifies the starting location of this page of items. format: text maxLength: 256
limit	integer(int32) (required) The number of items requested for this page response. The length of the items array may be less that limit. format: int32 minimum: 0 maximum: 100000
count	integer(int32) The total number of customers that were in a campaign's audience at the time that the campaign was completed. format: int32 minimum: 0 maximum: 1000000000
nextPage_url	string(uri-reference) The URL of the next page of customer engagement data. If this URL is omitted, there is no more customer engagement data. read-only format: uri-reference maxLength: 256

campaignCustomerEngagementItem

{
  "customerId": "8afb049f5672424d7b3a",
  "dataCustomerId": "8cac1a147f0f82cd0bee",
  "primaryPhoneNumber": "+19992345678",
  "primaryEmail": "email@example.com",
  "viewed": true,
  "clicked": true,
  "dismissed": true
}

Campaign Customer Engagement Item (v1.2.0)

An item of customer engagement data that indicates whether the customer has viewed, clicked, and/or dismissed any ad in a campaign.

Properties

Name	Description
Campaign Customer Engagement Item (v1.2.0)	object An item of customer engagement data that indicates whether the customer has viewed, clicked, and/or dismissed any ad in a campaign. Unevaluated Properties: false
customerId	resourceId The ID of the customer. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
dataCustomerId	string The ID of the customer in data systems. minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The primary phone number of the customer. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The primary email address of the customer. format: email maxLength: 255
viewed	boolean Indicates whether the customer has viewed any ad in a campaign.
clicked	boolean Indicates whether the customer has clicked any ad in a campaign.
dismissed	boolean Indicates whether the customer has dismissed any ad in a campaign.

campaignHistoryRecord

{
  "type": "scheduled",
  "state": "scheduled",
  "occurredAt": "2023-10-10T06:00:00Z",
  "updatedBy": {
    "id": "22707c1196c6f1c6938e",
    "username": "MetricMagician",
    "firstName": "Andy",
    "lastName": "Analytics"
  }
}

Campaign Activity Record (v1.2.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.2.0)	object Representation of a campaign history record. This response is used to see the user interactions with the campaign.
type	campaignHistoryRecordType (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	readOnlyTimestamp(date-time) (required) The date-time when the event occurred. read-only format: date-time minLength: 20 maxLength: 30
updatedBy	userAccountReference (required) The user that updated the campaign.
secondaryCampaignId	resourceId 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}$"
state	campaignState The state of the campaign as a result of the event. enum values: draft, scheduled, testing, active, paused, canceled, completed, archived

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",
      "state": "scheduled",
      "occurredAt": "2023-10-10T06:00:00Z",
      "updatedBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      }
    },
    {
      "type": "completed",
      "state": "completed",
      "occurredAt": "2023-10-20T06:00:00Z",
      "updatedBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      }
    }
  ]
}

Campaign History Records (v1.2.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.2.0)	object A list of campaign history records. This response is used to see the user interactions with the campaign.
items	array: [campaignHistoryRecord] (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)	object Day of the week and time range when an ad should be displayed.
daysOfWeek	array: [dayOfWeek] (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	string(time) (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	string(time) (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.",
  "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",
  "audience": {
    "id": "590c0c441f3241de9526",
    "name": "New Customers Ages 35-49",
    "state": "active",
    "customerCount": 12340,
    "totalCustomerCount": 2340659,
    "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",
          "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
          "contentType": "image/jpeg",
          "altText": "An advertisement for new banking CD rates"
        }
      }
    }
  ],
  "daysRunning": 10,
  "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"
  },
  "metricsResetAt": "2023-07-02T10:30:43.375Z"
}

Campaign Item (v2.5.0)

Summary representation of a campaign resource in a campaign collection.

Properties

Name	Description
Campaign Item (v2.5.0)	object Summary representation of a campaign resource in a campaign collection. Unevaluated Properties: false
name	string(text) (required) The name of this campaign. The name does not need to be unique. format: text minLength: 3 maxLength: 100
description	string(text) The description of this campaign, including the purpose/goals. format: text minLength: 3 maxLength: 500
schedule	campaignSchedule Start date, end date, and run time intervals for an ad campaign schedule.
id	resourceId (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	campaignState (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
metrics	campaignMetrics Metrics for campaigns.
ads	array: [campaignAd] (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
adCount	integer(int16) (required) The total number of ads in a campaign. read-only format: int16 minimum: 0 maximum: 100
daysRunning	integer(int16) The number of days that the campaign has run. This is only returned when the campaign state is active, paused, or completed. If the campaign state is active or paused, then this value represents the number of days that the campaign has run so far. When a campaign is paused or resumed, then this value is incremented if the campaign was run at any point during the day the action occurred. If the campaign state is completed, this value represents the total number of days that the campaign ran. read-only format: int16 minimum: 0 maximum: 5000
createdAt	readOnlyTimestamp(date-time) (required) The date-time when the campaign was created. read-only format: date-time minLength: 20 maxLength: 30
createdBy	userAccountReference (required) The admin user that created this campaign.
updatedAt	readOnlyTimestamp(date-time) The date-time when the campaign was last updated. read-only format: date-time minLength: 20 maxLength: 30
updatedBy	userAccountReference The admin user that updated this campaign.
metricsResetAt	readOnlyTimestamp(date-time) The date-time when the campaign metrics were last reset. read-only format: date-time minLength: 20 maxLength: 30
audience	campaignAudienceSummary Summary representation of an audience resource for a campaign. Unevaluated Properties: false
testingAudience	campaignAudienceSummary The testing audience for this campaign. This only applies when the campaign is in the testing state. Unevaluated Properties: false

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)	object Metrics for campaigns.
impressionCount	integer(int32) The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647
adClickCount	integer(int32) The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647
clickThroughRate	number(float) The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100
dismissCount	integer(int32) The number of times the ad was dismissed. read-only format: int32 minimum: 0 maximum: 2147483647
campaignId	readOnlyResourceId 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)	object Defines common campaign metrics fields. These may describe ads or campaigns.
impressionCount	integer(int32) The number of times the target group was presented with ads from the associated campaign. read-only format: int32 minimum: 0 maximum: 2147483647
adClickCount	integer(int32) The number of times an ad from the associated campaign was clicked. read-only format: int32 minimum: 0 maximum: 2147483647
clickThroughRate	number(float) The percentage of ad clicks to impressions. read-only format: float minimum: 0 maximum: 100
dismissCount	integer(int32) 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)	object A Collection of campaign metrics.
items	array: [campaignMetrics] (required) An array containing campaign metrics maxItems: 1000 items: object

campaignReference

{
  "id": "0399abed-fd3d",
  "name": "Holiday Savings Campaign",
  "state": "active",
  "audience": {
    "id": "590c0c441f3241de9526",
    "name": "New Customers Ages 35-49"
  }
}

Campaign Reference (v1.3.0)

An object that references a summary of the campaign.

Properties

Name	Description
Campaign Reference (v1.3.0)	object An object that references a summary of the campaign.
id	resourceId (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	string(text) (required) The campaign name. format: text minLength: 3 maxLength: 100
state	campaignState (required) 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 enum values: draft, scheduled, testing, active, paused, canceled, completed, archived
audience	campaignAudienceReference (required) An object that references a Campaign Audience by its id and name. Unevaluated Properties: false

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)	object Start date, end date, and run time intervals for an ad campaign schedule.
startAt	string(date-time) 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	string(date-time) 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: [campaignInterval] 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",
        "state": "active",
        "customerCount": 12340,
        "totalCustomerCount": 2340659,
        "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",
              "thumbnail_url": "http://cdn.example.com/links/thumbnail-image",
              "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"
          }
        ]
      },
      "daysRunning": 10,
      "createdBy": {
        "id": "22707c1196c6f1c6938e",
        "username": "MetricMagician",
        "firstName": "Andy",
        "lastName": "Analytics"
      },
      "createdAt": "2023-07-02T10:30:43.375Z",
      "updatedAt": "2023-07-02T10:30:43.375Z",
      "metricsResetAt": "2023-07-02T10:30:43.375Z"
    }
  ]
}

Campaign Collection (v2.5.0)

Collection of campaigns.

Properties

Name	Description
Campaign Collection (v2.5.0)	object Collection of campaigns.
items	array: [campaignItem] (required) An array containing campaign items. maxItems: 1000 items: object » Unevaluated Properties: false

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name	Description
Challenge Factor (v1.2.1)	object A challenge factor. See requiredIdentityChallenge for multiple examples.
id	challengeFactorId 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 id will become required in a future update to this schema. minLength: 3 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{3,48}$"
type	challengeFactorType (required) 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 enum values: sms, email, voice, securityQuestions, authenticatorToken
labels	array: [string] 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	challengeSecurityQuestions 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)	object A single security question within the questions array of the challengeSecurityQuestions
id	challengePromptId (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	string(text) (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)	object Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions	array: [challengeSecurityQuestion] (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 and not available for use. Archived audiences are deleted 30 days after being archived.

type: string

enum values: active, archived

customerUsername

"string"

Customer Username (v2.1.0)

A customer's login username.

type: string(text)

format: text
minLength: 5
maxLength: 128

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

entityTag

"W/\"325cf1cc-e370-4baf-8faf-c6db23f195a2\""

Entity Tag (v1.1.0)

An strong or weak HTTP Entity Tag (ETag). Strong ETags take the form "{printable-non-control-ASCII-characters}" but for backwards compatibility the surrounding double quotes are optional. Weak ETags take the form W/"{printable-non-control-ASCII-characters}".

type: string

minLength: 3
maxLength: 512
pattern: "^((\"?[\x21\x23-\x7e]{1,512}\"?)|(W\/\"[\x21\x23-\x7e]{1,509}\"))$"

extendedPhoneNumber

"+19105550155"

Extended Phone Number (v1.0.0)

A phone number with optional extension. Phone numbers are free-form strings and may include letters (such as '1-800-APITURE'), extensions (such as '919-555-1234 ext 34') or country code prefixes such as '+19105550155'.

type: string(extended-phone-number)

format: extended-phone-number
minLength: 5
maxLength: 20

identityChallengeText

{
  "factorSelection": "Select one of the following methods to verify your identity for security purposes.",
  "maximumFailures": "You have failed identity verification too many times. Contact your financial institution."
}

Identity Challenge Text (v1.0.0)

Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution.

The text values may be HTML or plain text.

Properties

Name	Description
Identity Challenge Text (v1.0.0)	object Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution. The text values may be HTML or plain text. Unevaluated Properties: false
factorSelection	string(text) Text shown to the user when the application asks them to choose which verification factor to use to verify their identity. format: text minLength: 8 maxLength: 512
maximumFailures	string(text) Text shown to the user when the user has failed identity verification the maximum number of attempts, as configured by the financial institution. format: text minLength: 8 maxLength: 512
email	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen email address. format: text minLength: 8 maxLength: 512
sms	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen mobile (SMS) phone number. format: text minLength: 8 maxLength: 512
authenticatorToken	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode from their hardware or software authenticator device. format: text minLength: 8 maxLength: 512
voice	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen voice phone number. format: text minLength: 8 maxLength: 512
securityQuestions	string(text) Text shown to the user when the client prompts the user to enter a an answer to one of their security questions. format: text minLength: 8 maxLength: 512

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string

minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

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)	object API problem or error response, as per RFC 9457 application/problem+json.
type	string(uri-reference) 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	string(text) 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	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) 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	readOnlyResourceId 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	readOnlyTimestamp(date-time) 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: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object
attributes	object 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.3.0)

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 403 Forbidden problem response when the 403 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

Name	Description
Required Challenge (v1.3.0)	object 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 403 Forbidden problem response when the 403 problem type name is challengeRequired. See the "Challenge API" for details.
operationId	challengeOperationId (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	readOnlyResourceId (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: [challengeFactor] (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
challengeText	identityChallengeText Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution. The text values may be HTML or plain text. Unevaluated Properties: false

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}$"

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 (v2.1.0)

The representation of a user account.

Properties

Name	Description
User Account Reference (v2.1.0)	object The representation of a user account.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text minLength: 5 maxLength: 128

---