How to use the API Verification Page

This article will help you learn about the API verification tool and how to use it to verify we're receiving your data.

Introduction to API Verification Page

The API Verification Page is a Wicked Reports feature designed to help you verify that your data is passing into your account as expected. All API data, including HTTP posts and Zaps, will show up in this page if your data is successfully received by Wicked Reports. 

The API Verification page can be found in your Wicked account through the left navigation bar, under the API & Uploaders dropdown menu. Once you've accessed the page, simply select the appropriate filters and ensure your data is passing accurately into Wicked Reports.

  • If your data is passing through correctly, then you're good to go!
  • If your data is not passing through correctly, then that likely means the data was not sent properly. Review our troubleshooting section, or send us a message at suppport@wickedreports.com.

It can take up to 30 minutes for new data to appear on this screen.

Display Filters:

Use these filters to select the type of data you're sending to us, and for what date range.

  • API DATA:
    • Contacts: All calls made to the /Contacts Endpoint when adding Contacts to Wicked Reports. 
    • Orders: All calls made to the /Orders Endpoint when adding Orders to Wicked Reports. 
    • OrderItems: All calls made to the /OrderItems Endpoint when adding Order Items to Wicked Reports
    • OrderPayments: All calls made to the /OrderPayments Endpoint when adding Order Payments to Wicked Reports. 
    • Products: All calls made to the /Products Endpoint when adding Products to Wicked Reports. 
    • Clicks: All calls made to the /Clicks Endpoint when adding Products to Wicked Reports.
    • Marketing: All calls made to the /Marketing Endpoint when adding Marketing data to Wicked Reports
  • Date Range:
    • This will determine the timeline of your search.
  • Live/Test Toggle:
    • Live ON: Will show all the live data being sent to Wicked Reports
    • Test ON: Will show all the test data being sent to Wicked Reports.

When using the Live/Test Toggle, data will only appear in the Test section if you have added the test header to your API endpoint.

API Specific Filters:

Use these filters, as you see fit, to modify the results of your search.

  • By Date Added:
    Shows the data on the date it was sent to Wicked
  • By Date Created:
    Shows the data on the date it was created in your Order System
  • Email:
    Search by the email of the user
  • Source System
    Search by the name of the platform your sending data from
  • Source ID
    • For the /Contacts Endpoint:
      Search by the Unique Contact ID, of the contact in the original system.
    • For the /Orders Endpoint:
      Search by the Unique Order ID, of the order in the original system.
  • Status
    Search by payment status when using /orderpayments endpoint
  • UTM x
    Search by UTMs when using /marketing endpoint
  • Without Duplicates Toggle
    • NO: Will include all duplicates entries sent into Wicked Reports
    • YES: Will not include duplicate entries sent into Wicked Reports

Order Validation Checklist:

This is a series of yes or no questions designed to help validate the quality of your API order data. This is not an exhaustive list, but will certainly prepare you with general coverage.    

  1. Do you have all the required key-value pairs? And, do they have the correct format?
  2. Are you using the correct conditional fields? (ContactID vs ContactEmail). ContactEmail is the recommended choice.
  3. Have you reviewed the optional key-value pairs? And, do they have the correct format?
  4. Verify your CreateDate:
    1. For your CreateDate value, are you certain you've converted it into a UTC+0 timezone?
      1. Note: If you're sending data via HTTP post or Zapier, this does not apply to you because Wicked does the conversion for you. However, all other data must be converted into UTC+0 before being passed into Wicked Reports.
    2. For your CreateDate value, are you certain you've formatted it correctly?
      (YYYY-MM-DD HH:MM:SS). It must be down to the second.
      1. Note: If you enter a false value here, your attribution will be inaccurate. 
  5. Verify that you are sending unique orders to Wicked on an immediate or daily basis:
    1. Are you certain you're sending a unique SourceID? (i.e. no duplicates SourceIDs)
    2. If you are sending IP Address, are you certain that you're using a unique IP Address per ContactEmail (or ContactID)?
  6. If your business has subscriptions, then you must verify your SubscriptionID:
    1. If your business utilizes subscriptions, did you include the SubscriptionID key-value pair?
    2. If your business utilizes subscriptions, are you certain you're using a unique Subscription ID?
  7. If you need to filter your reports by Product Information, then OrderItems and ProductData are required. Run Steps #1-5 to verify your OrderItems and ProductData.
  8. If you need to process Payment Status (e.g. refunds), then OrderPayments is required. Run Steps #1-5 to verify your OrderPayments

If you've answered yes (or N/A) to all these questions, then you can feel confident that you've done your very best to validate the quality of your data. If you've answered no to any of these questions, then please rectify it and turn that no into a yes.

If you need further assistance in validating the quality of your data, then please reach out to us at support@wickedreports.com.

Contact Validation Checklist:

This is a series of yes or no questions designed to help validate the quality of your API order data. This is not an exhaustive list, but will certainly prepare you with general coverage.    

  1. Have you added all the required key-value pairs? And, do they have the correct format?
  2. Have you reviewed the optional key-value pairs? And, do they have the correct format?
  3. Verify that you are sending unique contacts to Wicked on an immediate or daily basis:
    1. Are you certain you're using a unique SourceID? (i.e. no duplicates SourceIDs)
  4. Verify your CreateDate:
    1. For your CreateDate value, are you certain you've converted it into a UTC+0 timezone?
      Note: If you're sending data via HTTP post or Zapier, this does not apply because you'll simply be providing the timezone and we'll do the conversion. However, all other data must be converted into UTC+0 before being passed into Wicked Reports.
    2. For your CreateDate value, are you certain you've formatted it correctly?
      (YYYY-MM-DD HH:MM:SS). Must be down to the second.

If you've answered yes (or N/A) to all these questions, then you can feel confident that you've done your very best to validate the quality of your data. If you've answered no to any of these questions, then please rectify it and turn that no into a yes.

If you need further assistance in validating the quality of your data, then please reach out to us at support@wickedreports.com.

API Troubleshooting Questions:

Q: Have you confirmed that you have enabled the API?
Our recommendation is to turn on both the API integration and HTTP post-integration, for both contacts and orders. That'll ensure, in every case, your Inbound API is ready to receive your data. This can be done on the authorizations page in your Wicked account.

Q: Are you using the correct API Key, as provided by Wicked Reports?
Whenever you turn on your API integration on the authorizations page, you'll be provided with your account's unique API key. Please ensure this is the API key you're using.

Q: Are you using the correct headers?
Each API call should include an “apikey” custom header parameter. However, you may or may not want to include the "test" header, depending on whether or not you are trying to send test data.

Q: Are you sending test data?
Each API can include a "test" header. If this header is turned on, then you'll need to turn the Test toggle on so you can view the data. To send live data, you'll need to remove the "test" header.

Q: Are you using the correct Inbound API endpoints?
All our Inbound API endpoints are available in our API documentation. However, if you're sending data via HTTP Post, then you'll want to use the endpoints outlined in our HTTP Post articles.

Q: Are any required key-value pairs missing or incorrectly formatted?
All Inbound API Endpoints have some required and some optional key-value pairs. If you're missing any required keys, or have misformatted any of the values, then Wicked Reports will not successfully accept your data. Please ensure you have all the required keys and the values are formatted as per our technical documentation on API Endpoints