Bankrate Credit Cards Feeds API Version 1.13.1

This API allows you as an affiliate to pull reports and product information for use in your application. You will need an API Key. If you do not already have one, please contact your Bankrate Creditcards representative.

If you have any issues or need assistance using the API, please contact your Bankrate Creditcards representative.

Advertisers ¶

Advertiser Collection ¶

Get a Collection of Advertisers.

List all Advertisers
GET`/api/v1/advertisers{?api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/advertisers?api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "advertisers": [
      {
        "id": 1,
        "name": "The Bank Program",
        "issuer": "The Bank"
      },
      {
        "id": 2,
        "name": "Best Program",
        "issuer": "Aperture Financial"
      }
    ]
  }
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Banner Referrals Report ¶

Transaction Report ¶

This feed provides a summary of banner referrals (clicks, sales, applications) for various parameter sets.

The response given will give you the following transactional data:

Referral click id
Referral click date
Originating website
Marketing creative id
Marketing creative name
Destination id
Destination name
User variable
IP Address of the visitor
Referral URL
Click id
Clicked card id
Clicked card name
Clicked issuer id
Clicked issuer name
Click date
Sale id
Sale process date
Sale commission
Sale adjustment amount
Cross-sale indicator

Examples: For example you could request all banner referrals for the month of February grouped by product.

/api/v1/banner-referrals/report?api_key=&start_date=2016-01-01&end_date=2016-02-01

Results can be filtered by a date range that can span up to 31 days.

List all Banner Referrals
GET`/api/v1/banner-referrals/report{?api_key,product_id,start_date,end_date,user_variable,page,limit}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/banner-referrals/report?api_key=&product_id=&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&user_variable=&page=1&limit=1000

URI Parameters

HideShow

api_key: string (required)
The api key for your account.
start_date: date (optional) Example: YYYY-MM-DD
The banner referral date to start listing data.
end_date: date (optional) Example: YYYY-MM-DD
The banner referral date to stop listing data.
product_id: int (optional)
Display a list of banner referrals that only include this product.
user_variable: string (optional)
Display a list of banner referrals that only include this user variable
page: int (optional) Example: 1
Page number (Results are paginated if over 1000 results are returned)
limit: number (optional) Example: 1000
The number of results to display per page when paginating

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "transactions": [
      {
        "referral_click_id": "123456789",
        "referral_click_date": "2019-05-07 21:39:44",
        "referral_website_id": 12345,
        "referral_website_url": "http://www.creditcards.com",
        "referral_card_id": "abcdefg123",
        "referral_card_title": "Banner to CreditCards.com",
        "referral_destination_id": 123,
        "referral_destination_name": "CreditCards.com",
        "referral_user_variable": "user|variable|for|tracking",
        "referral_visitor_ip_address": "127.0.0.1",
        "referral_http_referrer_url": "https://www.creditcards.com/test-site",
        "click_id": "0987654321",
        "click_card_id": "123456789",
        "click_card_title": "Test Card",
        "click_merchant_id": 99,
        "click_merchant_name": "Great Bank",
        "click_date": "2019-05-08 15:25:35",
        "sale_id": 987654321,
        "sale_process_date": "2019-05-08 15:25:35",
        "sale_commission": 100,
        "sale_adjustment": 50,
        "sale_cross_ind": false
      }
    ]
  },
  "meta": {
    "pagination": {
      "total_items": 98,
      "items_per_page": 1000,
      "current_page": 1,
      "total_pages": 1
    },
    "date_range": {
      "start": "2019-04-09",
      "end": "2019-05-09"
    }
  }
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Categories ¶

Category Collection ¶

Get a Collection of Categories and Card Rankings within each Category.

List all Rankings
GET`/api/v1/categories{?api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/categories?api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{

    "status_code": 200,
    "message": "OK",
    "data": {
        "categories": [
            {
                "id": 12,
                "name": "Balance Transfer Credit Cards",
                "rankings": [
                    {
                        "product_id": "22189517",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039728&fid=12&pos=1",
                        "lid": 26039728,
                        "rank": 1
                    },
                    {
                        "product_id": "22189522",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=2",
                        "lid": 26039765,
                        "rank": 2
                    },
                    {
                        "product_id": "22089566",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=3",
                        "lid": 26039765,
                        "rank": 3
                    },
                    {
                        "product_id": "22035733",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=4",
                        "lid": 26039765,
                        "rank": 4
                    },
                    {
                        "product_id": "220310365",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=5",
                        "lid": 26039765,
                        "rank": 5
                    },
                    {
                        "product_id": "22089398",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=6",
                        "lid": 26039765,
                        "rank": 6
                    },
                    {
                        "product_id": "221210130",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=7",
                        "lid": 26039765,
                        "rank": 7
                    },
                    {
                        "product_id": "22086285",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=8",
                        "lid": 26039765,
                        "rank": 8
                    },
                    {
                        "product_id": "22089909",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=9",
                        "lid": 26039765,
                        "rank": 9
                    },
                    {
                        "product_id": "23066281",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=10",
                        "lid": 26039765,
                        "rank": 10
                    },
                    {
                        "product_id": "22089399",
                        "position_link": "http://oc.brcclx.com/t/?lid=26039765&fid=12&pos=11",
                        "lid": 26039765,
                        "rank": 11
                    }
                ]
            },
        ]
    }
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Clicks ¶

Click Collection ¶

Get a list of Clicks. Results can be filtered by a date range that can span up to 31 days.

List all Clicks
GET`/api/v1/clicks{?start_date,end_date,advertiser_id,product_id,product_type_id,category_id,page,api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/clicks?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&advertiser_id=1&product_id=1&product_type_id=1&category_id=1&page=1&api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.
start_date: date (optional) Example: YYYY-MM-DD
The click date to start listing payments.
end_date: date (optional) Example: YYYY-MM-DD
The click date to stop listing payments.
product_id: int (optional) Example: 1
Display a list of clicks that only include this product.
product_type_id: int (optional) Example: 1
Display a list of clicks that only include this product type.
category_id: int (optional) Example: 1
Display a list of clicks that only include this category.
advertiser_id: int (optional) Example: 1
Display a list of clicks that are a part of this advertiser.
page: int (optional) Example: 1
Page number (Results are paginated if over 1000 results are returned)

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "clicks": [
      {
        "id": 1234,
        "tracking_id": "abcd1234",
        "affiliate_id": "123",
        "website": {
          "id": 123,
          "url": "http://example.com"
        },
        "product": {
          "id": "123",
          "name": "Gold Card",
          "issuer": "Some Bank",
          "advertiser": {
            "id": 123,
            "name": "Cards Program"
          },
          "product_type": {
            "id": "456",
            "name": "Cards Product Type"
          }
        },
        "category": {
          "id": 123,
          "name": "Good Credit Cards"
        },
        "user_variable": "ABC123",
        "user_agent": "Mozilla/5.0 (Linux U Android 4.1.2 en-us SCH-I535 Build/JZO54K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30",
        "ip_address": "`127.0.0.1",
        "referer_url": "http://example.com",
        "date_inserted": "2014-06-01 00:00:00"
      }
    ]
  },
  "meta": {
    "pagination": {
      "total_items": 1500,
      "items_per_page": 1000,
      "current_page": 1,
      "total_pages": 2
    },
    "date_range": {
      "start": "2014-06-01",
      "end": "2014-07-01"
    }
  }
}

Response 422

HideShow

Headers

Content-Type: application/json

Body

{
    status_code: 422,
    message: "The validation for the specified resource has failed.",
    errors: [
        "The category must be a number.",
        "Date range should not span more than 31 days"
    ]
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Payments ¶

Payments Collection ¶

Get a list of payments for your account.

List all Payments
GET`/api/v1/payments{?api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/payments?api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "payments": [
      {
        "id": "2",
        "affiliate_id": "abc123",
        "reference_code": "523",
        "amount": 11.15,
        "type": "Check",
        "payment_date": "2014-08-02 14:08:08"
      },
      {
        "id": "6",
        "affiliate_id": "abc123",
        "reference_code": "344",
        "amount": 8534,
        "type": "Wire Transfer",
        "payment_date": "2014-08-04 14:46:47"
      }
    ]
  }
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
   "status_code":401,
   "message":"You are not authorized to view the requested page resource.",;
   "errors":[]
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Payment Sales ¶

Get a list of sales for a payment.

List all sales for a Payment
GET`/api/v1/payments/{payment_id}/sales{?page,api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/payments/payment_id/sales?page=1&api_key=

URI Parameters

HideShow

payment_id: number (required)
The id of the payment which to return.
api_key: string (required)
The api key for your account.
page: int (optional) Example: 1
Page number (Results are paginated if over 1000 results are returned)

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "sales": [
      {
        "id": "123",
        "click_id": "123",
        "account_id": "123",
        "website": {
          "id": 123,
          "url": "http://www.example.com"
        },
        "product": {
          "id": "123",
          "name": "Gold Card",
          "advertiser": {
            "id": 43,
            "name": "Chase"
          }
        },
        "category": {
          "id": 0,
          "name": null
        },
        "user_variable": "topcardart",
        "status": "paid",
        "cross_sale": false,
        "amount": 55,
        "adjustments": 0,
        "click_date": "2012-11-15 22:33:54",
        "process_date": "2012-12-12 20:30:00"
      }
    ]
  },
  "meta": {
    "pagination": {
      "total_items": 94,
      "items_per_page": 1,
      "current_page": 1,
      "total_pages": 94
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 400,
  "message": "Page out of bounds",
  "errors": []
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 401,
  "message": "You are not authorized to view the requested page resource.",
  "errors": []
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Payment Bonuses ¶

Get a list of bonuses for a payment, grouped by bonus type.

List all bonuses for a Payment
GET`/api/v1/payments/{payment_id}/bonuses{?api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/payments/payment_id/bonuses?api_key=

URI Parameters

HideShow

payment_id: number (required)
The id of the payment which to return.
api_key: string (required)
The api key for your account.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "bonuses": {
      "amounts": [
        {
          "type": "Make Good",
          "amount": 150
        },
        {
          "type": "Affiliate Slotting Fee",
          "amount": 50
        },
        {
          "type": "Referral Bonus",
          "amount": 25
        },
        {
          "type": "Prepayment",
          "amount": 0
        }
      ],
      "total": 225
    }
  }
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 401,
  "message": "You are not authorized to view the requested page resource.",
  "errors": []
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Product Links ¶

Product Link Collection ¶

Get a Collection of Product Links.

List all Product Links
GET`/api/v1/product-links{?device_type_id,link_type_id,api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/product-links?device_type_id=&link_type_id=&api_key=

URI Parameters

HideShow

api_key

string (required)

The api key for your account.

device_type_id

integer (required)

The id for the type of device (1 = Desktop, 2 = Mobile)

Choices: 1 2

link_type_id

integer (required)

The id for the type of link (4 = Terms)

Choices: 4

Response 200

HideShow

Headers

Content-Type: application/json

Body

{

    "status_code": 200,
    "message": "OK",
    "data": {
        "product_links": [

            {
                "card_id": "220310542",
                "name": "Blue Cash Everyday&#174; Card from American Express",
                "issuer_id": 2,
                "urls": [
                    {
                        "url": "https://www.americanexpress.com/us/credit-cards/personal-card-application/terms/blue-cash-everyday-credit-card/26129-10-0/?print&noBox=y#terms-details",
                        "device_type": "mobile",
                        "link_type": "terms"
                    }
                ]
            }
    }

}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Product Types ¶

Product Type Collection ¶

Get a Collection of Product Types.

List all Product Types
GET`/api/v1/product-types{?api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/product-types?api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "product_types": [
      {
        "id": 1,
        "name": "Credit Cards"
      },
      {
        "id": 2,
        "name": "Credit Repair"
      }
    ]
  }
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Products ¶

Product Collection ¶

Get a Collection of Products.

List all Products
GET`/api/v1/products{?advertiser_id,network,api_key}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/products?advertiser_id=1&network=mastercard&api_key=

URI Parameters

HideShow

api_key: string (required)
The api key for your account.
advertiser_id: int (optional) Example: 1
Display a list of products that are a part of this advertiser
network: string (optional) Example: mastercard
Display a list of products that belong to this network (html-encoded string)

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "products": [
      {
        "id": "22034405",
        "name": "The Business Platinum Card&#174; from American Express OPEN",
        "issuer_id": {
          "id": 2,
          "name": "American Express"
        },
        "link_url": "http://oc.brcclx.com/t/?lid=2174445",
        "apply_by_phone_number": "",
        "sku": "1234567asb",
        "bullets": "<ul><li>Welcome Offer: Get 40,000 Membership Rewards&reg; points after you spend $5,000 in purchases on the Card within your first 3 months of Card Membership.</li><li>The Business Platinum Card's premium benefits include world-class platinum service, travel benefits, rewards that can help reduce expenses and access to one-of-a-kind events.</li><li>Membership Rewards&reg; Program: Get one point for each dollar of eligible purchases. There is no limit to the number of points you can get.</li><li>30% Airline Bonus: Use Membership Rewards&reg; Pay with Points for all or part of a flight with your selected qualifying airline, and you can get 30% of the points back.</li><li>Airport Lounge Access Program: Elevate your business travel experience with complimentary access to over 700 airport lounges worldwide.</li><li>Complimentary internet access: Enroll your Card with Gogo and Boingo and get 10 Gogo inflight internet passes annually and unlimited Wi-Fi at Boingo hotspots.</li><li>Terms &amp; Restrictions Apply</li><li><a href=\"https://www262.americanexpress.com/business-card-application/business-platinum-charge-card/tandc/42732-AJTnC-0/?key=tncBody\" target=\"blank\"> See Rates &amp; Fees</a></li></ul>",
        "image": "the-business-platinum-card-from-american-express-open-013015.png",
        "advertiser": {
          "advertiser_id": 41,
          "name": "American Express"
        },
        "product_type": {
          "id": 15,
          "name": "Credit Cards"
        },
        "card_data": {
          "network": "American Express",
          "purchases": {
            "regular_apr": {
              "value": 999,
              "display": "N/A",
              "type": "variable",
              "min": 999,
              "max": 999
            },
            "intro_apr": {
              "value": 999,
              "display": "N/A",
              "period": {
                "value": 0,
                "min": 0,
                "max": 0,
                "end_date": "0000-00-00"
              }
            }
          },
          "balance_transfers": {
            "regular_apr": {
              "value": false,
              "display": "N/A"
            },
            "intro_apr": {
              "value": 0,
              "display": "N/A",
              "period": {
                "value": 0,
                "min": 0,
                "max": 0,
                "end_date": null
              }
            }
          },
          "fees": {
            "annual": {
              "value": 450,
              "display": "$450"
            },
            "balance_transfer": {
              "display": "See Terms"
            },
            "activation": {
              "value": 0,
              "display": "$0"
            },
            "atm": {
              "value": 0,
              "display": "$0"
            },
            "pin_transaction": {
              "value": 0,
              "display": "$0"
            },
            "signature_transaction": {
              "value": 0,
              "display": "$0"
            },
            "load": {
              "value": 0,
              "display": "$0"
            }
          },
          "credit_needed": {
            "value": 4,
            "display": "Excellent Credit"
          }
        },
        "last_updated": "2016-04-29 11:53:38"
      }
    ]
  }
}

Response 422

HideShow

Headers

Content-Type: application/json

Body

{
    status_code: 422,
    message: "The validation for the specified resource has failed.",
    errors: [
        "The category must be a number."
    ]
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Product Image Libraries ¶

Bankrate Creditcards also provides product images. Each product within the feed has a field called ‘image’. The feed does not provide a full path with each image. The advantage to this is the ability to choose from multiple image libraries which may differ on size or style. The same image filename exists in each library so images can be changed just by pointing to a different library.

Library Base URL	Image Size
https://cdn.creditcards.com/shared/images/cards/500x315/	500px x 315px
https://cdn.creditcards.com/shared/images/cards/251x158/	251px x 158px
https://cdn.creditcards.com/shared/images/cards/191x120/	191px x 120px

Sales ¶

Sales Collection ¶

Get a list of sales for your account. Sales can be filtered by a date range that can span up to 31 days.

List all Sales
GET`/api/v1/sales/{?api_key,advertiser_id,product_id,product_type_id,category_id,start_date,end_date,page}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/sales/?api_key=&advertiser_id=&product_id=&product_type_id=&category_id=&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&page=1

URI Parameters

HideShow

api_key: string (required)
The api key for your account.
advertiser_id: string (optional)
Filter results by advertiser id
product_id: number (optional)
Filter results by product id
product_type_id: number (optional)
Filter results by product type.
category_id: number (optional)
Filter results by category id
start_date: date (optional) Example: YYYY-MM-DD
Filter results by process start date
end_date: date (optional) Example: YYYY-MM-DD
Filter results by process end date
page: int (optional) Example: 1
Page number (Results are paginated if over 1000 results are returned)

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "sales": [
      {
        "id": "1234567890abcd",
        "click_id": "D2000123",
        "account_id": "123",
        "website": {
          "id": 123,
          "url": "http://example.com"
        },
        "product": {
          "id": "123",
          "name": "Gold Card",
          "advertiser": {
            "advertiser_id": 123,
            "name": "The Bank"
          },
          "product_type": {
            "id": "456",
            "name": "Cards Product Type"
          }
        },
        "category": {
          "id": 17,
          "name": "Business Credit Cards"
        },
        "user_variable": "ABC123",
        "status": "paid",
        "cross_sale": false,
        "amount": 120,
        "adjustments": 23,
        "click_date": "2014-06-17 13:59:32",
        "process_date": "2014-06-20 11:01:35"
      }
    ]
  },
  "meta": {
    "pagination": {
      "total_items": 1400,
      "items_per_page": 1000,
      "current_page": 2,
      "total_pages": 2
    },
    "date_range": {
      "start": "2014-06-01",
      "end": "2014-06-20"
    }
  }
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 401,
  "message": "You are not authorized to view the requested page resource.",
  "errors": []
}

Response 422

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 422,
  "message": "The validation for the specified resource has failed.",
  "errors": [
    "The start date must be a date before end date.",
    "Date range should not span more than 31 days"
  ]
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Transaction Report ¶

This feed provides a summary of transactions (clicks, sales, applications) for various parameter sets.

The response given will give you the following transactional data:

Number of clicks
Number of sales by the click date
Number of sales by the process date
Number of applications by the click date
Number of applications by the process date
Sale amount by click date
Sale amount by process date
Adjustment amount by click date
Adjustment amount by process date

Examples: For example you could request all transactions for the month of February grouped by product.

/api/v1/transactions/report?api_key=&by=product_id&start_date=2016-01-01&end_date=2016-02-01

Results can be filtered by a date range that can span up to 31 days.

List all Transactions
GET`/api/v1/transactions/report{?api_key,advertiser_id,product_id,product_type_id,start_date,end_date,category_id,by,page,limit}`

Example URI

GET https://feeds.bankratecreditcards.com/api/v1/transactions/report?api_key=&advertiser_id=&product_id=&product_type_id=&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&category_id=&by=&page=1&limit=1000

URI Parameters

HideShow

api_key

string (required)

The api key for your account.

start_date

date (optional) Example: YYYY-MM-DD

The transaction date to start listing data.

end_date

date (optional) Example: YYYY-MM-DD

The transaction date to stop listing data.

product_id

int (optional)

Display a list of transactions that only include this product.

product_type_id

int (optional)

Display a list of transactions that only include this product type.

category_id

int (optional)

Display a list of transactions that only include this category.

advertiser_id

int (optional)

Display a list of transactions that are a part of this advertiser.

page

int (optional) Example: 1

Page number (Results are paginated if over 1000 results are returned)

limit

number (optional) Example: 1000

The number of results to display per page when paginating

by

string (required)

The property to group by

Choices: day product_id user_variable product_type_id advertiser_id category_id

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 200,
  "message": "OK",
  "data": {
    "transactions": [
      {
        "transaction_date": "2016-01-01",
        "clicks": 98,
        "sales_by_click_date": 4,
        "sales_by_process_date": 17,
        "applications_by_click_date": 0,
        "applications_by_process_date": 0,
        "sale_amount_by_click_date": 292.48,
        "sale_amount_by_process_date": 4040,
        "adjustment_amount_by_click_date": 0,
        "adjustment_amount_by_process_date": 0
      },
      {
        "transaction_date": "2016-01-02",
        "clicks": 79,
        "sales_by_click_date": 8,
        "sales_by_process_date": 10,
        "applications_by_click_date": 3,
        "applications_by_process_date": 3,
        "sale_amount_by_click_date": 599.96,
        "sale_amount_by_process_date": 2155,
        "adjustment_amount_by_click_date": 0,
        "adjustment_amount_by_process_date": 0
      }
    ]
  },
  "meta": {
    "pagination": {
      "total_items": 2,
      "items_per_page": 1000,
      "current_page": 1,
      "total_pages": 1
    },
    "date_range": {
      "start": "2016-01-01",
      "end": "2016-01-02"
    },
    "totals": {
      "clicks": 177,
      "sales_by_click_date": 12,
      "sales_by_process_date": 27,
      "applications_by_click_date": 3,
      "applications_by_process_date": 3,
      "sale_amount_by_click_date": 892.44,
      "sale_amount_by_process_date": 6195,
      "adjustment_amount_by_click_date": 0,
      "adjustment_amount_by_process_date": 0
    }
  }
}

Response 422

HideShow

Headers

Content-Type: application/json

Body

{
    status_code: 422,
    message: "The validation for the specified resource has failed.",
    errors: [
        "The category must be a number.",
        "Date range should not span more than 31 days"
    ]
}

Response 429

HideShow

Headers

Content-Type: application/json

Body

{
  "status_code": 429,
  "message": "You have exceeded the allowed number of requests per hour",
  "errors": []
}

Advertisers ¶

Advertiser Collection ¶

List all AdvertisersGET/api/v1/advertisers{?api_key}

Example URI

Headers

Body

Headers

Body

Banner Referrals Report ¶

Transaction Report ¶

List all Banner ReferralsGET/api/v1/banner-referrals/report{?api_key,product_id,start_date,end_date,user_variable,page,limit}

Example URI

Headers

Body

Headers

Body

Categories ¶

Category Collection ¶

List all RankingsGET/api/v1/categories{?api_key}

Example URI

Headers

Body

Headers

Body

Clicks ¶

Click Collection ¶

List all ClicksGET/api/v1/clicks{?start_date,end_date,advertiser_id,product_id,product_type_id,category_id,page,api_key}

Example URI

Headers

Body

Headers

Body

Headers

Body

Payments ¶

Payments Collection ¶

List all PaymentsGET/api/v1/payments{?api_key}

Example URI

Headers

Body

Headers

Body

Headers

Body

Payment Sales ¶

List all sales for a PaymentGET/api/v1/payments/{payment_id}/sales{?page,api_key}

Example URI

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Payment Bonuses ¶

List all bonuses for a PaymentGET/api/v1/payments/{payment_id}/bonuses{?api_key}

Example URI

Headers

Body

Headers

Body

Headers

Body

Product Links ¶

Product Link Collection ¶

List all Product LinksGET/api/v1/product-links{?device_type_id,link_type_id,api_key}

Example URI

Headers

Body

Headers

Body

Product Types ¶

Product Type Collection ¶

List all Product TypesGET/api/v1/product-types{?api_key}

Example URI

Headers

Body

Headers

Body

List all Advertisers
GET`/api/v1/advertisers{?api_key}`

List all Banner Referrals
GET`/api/v1/banner-referrals/report{?api_key,product_id,start_date,end_date,user_variable,page,limit}`

List all Rankings
GET`/api/v1/categories{?api_key}`

List all Clicks
GET`/api/v1/clicks{?start_date,end_date,advertiser_id,product_id,product_type_id,category_id,page,api_key}`

List all Payments
GET`/api/v1/payments{?api_key}`

List all sales for a Payment
GET`/api/v1/payments/{payment_id}/sales{?page,api_key}`

List all bonuses for a Payment
GET`/api/v1/payments/{payment_id}/bonuses{?api_key}`

List all Product Links
GET`/api/v1/product-links{?device_type_id,link_type_id,api_key}`

List all Product Types
GET`/api/v1/product-types{?api_key}`

List all Products
GET`/api/v1/products{?advertiser_id,network,api_key}`

List all Sales
GET`/api/v1/sales/{?api_key,advertiser_id,product_id,product_type_id,category_id,start_date,end_date,page}`

List all Transactions
GET`/api/v1/transactions/report{?api_key,advertiser_id,product_id,product_type_id,start_date,end_date,category_id,by,page,limit}`