This API is intended to handle infrequent periodic automated requests to pull report-like data. It is not intended to handle frequent requests as part of any real-time integration. If you make too many frequent requests, your access to the Report API may be restricted or blocked.
To make a request, you must POST to this URL with JSON data as the BODY of the posted request, and with your account's API Key in a field named "api_key" in that JSON.
To get your API Key, contact your support rep.
A simple sample request is below, for all registrations (from the productRegistration resource) on a specific day, including some information about the User and the Product from those related resources.
The best way to learn how to use this API is to make test requests using a tool like PostMan.
{
"api_key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"format":"json",
"resource":"productRegistration",
"fields":{
"price_before_discount":true,
"amount_discounted":true,
"price_after_discount":true,
"transaction_at":true,
"user.firstname":true,
"user.lastname":true,
"user.email":true,
"product.title":true
},
"filters":{
"transaction_at":{">=":"2021-04-06 00:00:00", "<=":"2021-04-06 23:59:59"}
}
}
For further guidance, and/or to have one of our programmers suggest a query to return the data you want, contact your support rep.
| Name | Description |
|---|---|
| id | Accounting Code |
| Name | Resource | Description |
|---|---|---|
| products | product | Product |
| Name | Actual value | Description |
|---|---|---|
| revenue | products.total_revenue | Revenue |
| number_registrations | products.total_number_registrations | Number of Registrations |
| Name | Description |
|---|---|
| total_revenue | Total Accounting Codes Revenue |
| total_number_registrations | Total Number of Accounting Codes Registrations |
| Name | Description |
|---|---|
| id | ID |
| access_datetime | Access Datetime |
| minutes_accessed | Minutes Accessed |
| user_id | |
| asset_id | |
| asset_title | |
| product_id | |
| finished | |
| cart_product_id | |
| asset_type | |
| asset_requires |
| Name | Resource | Description |
|---|---|---|
| user | user | User |
| product | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| total_number_webinars_viewed | Number Of Webinars Viewed |
| test | Number Of Webinars Viewed |
| product_completion | Number Of Webinars Viewed |
| Name | Description |
|---|---|
| id | Cart ID |
| user_id | User ID |
| status | Status |
| registered_at | Registered DateTime |
| updated_at | Updated DateTime |
| Name | Resource | Description |
|---|---|---|
| discountUsage | discountUsage | Discount Usage |
| productRegistration | productRegistration | Product Registration |
| user | user | User |
| Name | Actual value | Description |
|---|---|---|
| discount_name | discountUsage.all_discount_name | Discount Name |
| discount_remote_id | discountUsage.all_discount_remote_id | Discount Remote ID |
| discount_code | discountUsage.all_discount_code | Discount Code |
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | Category ID |
| name | Category Name |
| description | Description |
| sum0 | Users with 0 interest |
| sum1 | Users with 1 interest |
| sum2 | Users with 2 interest |
| sum3 | Users with 3 interest |
| sum4 | Users with 4 interest |
| sum5 | Users with 5 interest |
| avg | Average user interest |
| Name | Resource | Description |
|---|---|---|
| products | product | Category Products |
| Name | Actual value | Description |
|---|---|---|
| revenue | products.total_revenue | Revenue |
| number_registrations | products.total_number_registrations | Number of Registrations |
| Name | Description |
|---|---|
| total_revenue | Total Revenue |
| total_number_registrations | Total Number of Registrations |
| all_names | Names |
| Name | Description |
|---|---|
| id | Discount Usage ID |
| discount_code | Discount Code |
| discount_name | Discount Name |
| discount_remote_id | Discount Remote ID |
| cart_id |
| Name | Resource | Description |
|---|---|---|
| carts | cart | Cart |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| all_discount_code | Discount Code |
| all_discount_name | Discount Name |
| all_discount_remote_id | Discount Remote ID |
| Name | Description |
|---|---|
| number_earned_credits | Credits Earned |
| credits_type | Credits Type |
| earning_method | Earning Method |
| last_edited | Last Edited |
| certificate_num | Certificate Number |
| user_id | |
| asset_id | |
| asset_title | Component Name |
| product_id | |
| cart_product_id | |
| created_at | Credit Earned Date & Time |
| updated_at | Date Credits Entered Into System |
| is_cle_credit | Is CLE credit |
| cle_bar_number | CLE credit bar number |
| cle_state | CLE credit state |
| course_id | Course ID |
| min_per_credit | Minutes per CLE credit |
| total_cle_credits | Number Total CLE credits |
| general_cle_credits | Number General CLE credits |
| speciality_credits_array | Array of CLE Specialty credits |
| speciality_credits_list | List of CLE Specialty credits |
| total_speciality_credits | Total Number of CLE Specialty credits |
| custom_certificate_fields | Cert Options |
| user_filled_certificate_fields | User Filled Certificate Fields |
| expiration_date | Credit Expiration Date |
| license_number | License Number |
| raw_cle_data | Raw CLE Data Block |
| Name | Resource | Description |
|---|---|---|
| user | user | User |
| product | product | Product |
| product_package | package | Package |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| total_number_earned_credits | Total Credits Number |
| stats | Total Credits Stats |
| Name | Description |
|---|---|
| id | Live In-Person Event ID |
| title | Event Title |
| asset_id | Component ID |
| product_id | Product ID |
| location | Event Location |
| street | Event Location Street |
| city | Event Location City |
| state | Event Location State |
| zip_code | Event Location Zip-Code |
| begin_at | Begin Date/Time |
| end_at | End Date/Time |
| timezone | Timezone |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | Package Product ID |
| remote_product_id | Remote Product ID |
| remote_accounting_code | Remote Accounting Code |
| remote_registration_url | Remote Registration URL |
| accounting_date | Accounting Date |
| title | Package Title |
| url_slug | Product URI |
| url | Product Link URL |
| description | Product Description |
| is_package | Is Package |
| search | For Search |
| average_score | Average customer rating |
| created_at | Product Creation Date Time |
| start_sales_at | Start Sales Date Time |
| end_sales_at | End Sales Date Time |
| auto_close_status | Auto Close Status |
| auto_status_date | Auto Close Date Time |
| speakers | Speakers |
| speakers_details | Speakers With Details |
| meta_description | Meta Description |
| meta_keywords | Meta Keywords |
| expires_on | Expiration Date |
| status | Product Status |
| Name | Resource | Description |
|---|---|---|
| categories | category | Products Categories |
| productTypes | productType | Products Types |
| productRegistrations | productRegistration | Product Registrations |
| quizResults | quizResult | Quiz Results |
| webContent | webContent | Web Content |
| liveInPerson | liveInPerson | Live In-Person |
| Name | Actual value | Description |
|---|---|---|
| revenue | productRegistrations.total_revenue | Product Revenue |
| number_registrations | productRegistrations.total_number_registrations | Number of Product Registrations |
| number_cancellations | productRegistrations.total_number_cancellations | Number of Product Cancellations |
| number_transactions | productRegistrations.count | Number of Product Transactions |
| product_types_names | productTypes.all_names | Product Types Names |
| categories_names | categories.all_names | Categories Names |
| Name | Description |
|---|---|
| total_revenue | Total Revenue |
| total_number_registrations | Number of Registrations |
| total_number_cancellations | Number of Cancellations |
| Name | Description |
|---|---|
| id | ID |
| payment_method | Method: credit or check |
| payment_check_received | Check received |
| date_received | Date received |
| check_number | Check number |
| bank | Bank |
| card_type | Card type |
| card_partial | Card last four |
| transaction_id | Transaction id |
| firstname | First Name |
| lastname | Last Name |
| company | Company |
| street_address | Address |
| city | City |
| state | State |
| zip | Zip |
| cart_id |
| Name | Resource | Description |
|---|
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | Product ID |
| remote_product_id | Remote Product ID |
| remote_accounting_code | Remote Accounting Code |
| remote_registration_url | Remote Registration URL |
| accounting_date | Accounting Date |
| title | Product Title |
| url_slug | Product URI |
| url | Product Link URL |
| description | Product Description |
| is_package | Is Package |
| search | For Search |
| average_score | Average customer rating |
| created_at | Product Creation Date Time |
| start_sales_at | Start Sales Date Time |
| end_sales_at | End Sales Date Time |
| auto_close_status | Auto Close Status |
| auto_status_date | Auto Close Date Time |
| speakers | Speakers |
| speakers_details | Speakers With Details |
| meta_description | Meta Description |
| meta_keywords | Meta Keywords |
| expires_on | Expiration Date |
| status | Product Status |
| Name | Resource | Description |
|---|---|---|
| categories | category | Products Categories |
| productTypes | productType | Products Types |
| productRegistrations | productRegistration | Product Registrations |
| quizResults | quizResult | Quiz Results |
| webContent | webContent | Web Content |
| liveInPerson | liveInPerson | Live In-Person |
| Name | Actual value | Description |
|---|---|---|
| revenue | productRegistrations.total_revenue | Product Revenue |
| number_registrations | productRegistrations.total_number_registrations | Number of Product Registrations |
| number_cancellations | productRegistrations.total_number_cancellations | Number of Product Cancellations |
| number_transactions | productRegistrations.count | Number of Product Transactions |
| product_types_names | productTypes.all_names | Product Types Names |
| categories_names | categories.all_names | Categories Names |
| Name | Description |
|---|---|
| total_revenue | Total Revenue |
| total_number_registrations | Number of Registrations |
| total_number_cancellations | Number of Cancellations |
| Name | Description |
|---|---|
| id | Product ID |
| remote_product_id | Remote Product ID |
| remote_accounting_code | Remote Accounting Code |
| remote_registration_url | Remote Registration URL |
| accounting_date | Accounting Date |
| title | Product Title |
| url_slug | Product URI |
| url | Product Link URL |
| description | Product Description |
| is_package | Is Package |
| search | For Search |
| average_score | Average customer rating |
| created_at | Product Creation Date Time |
| start_sales_at | Start Sales Date Time |
| end_sales_at | End Sales Date Time |
| auto_close_status | Auto Close Status |
| auto_status_date | Auto Close Date Time |
| speakers | Speakers |
| speakers_details | Speakers With Details |
| meta_description | Meta Description |
| meta_keywords | Meta Keywords |
| expires_on | Expiration Date |
| status | Product Status |
| Name | Resource | Description |
|---|---|---|
| categories | category | Products Categories |
| productTypes | productType | Products Types |
| productRegistrations | productRegistration | Product Registrations |
| quizResults | quizResult | Quiz Results |
| webContent | webContent | Web Content |
| liveInPerson | liveInPerson | Live In-Person |
| Name | Actual value | Description |
|---|---|---|
| revenue | productRegistrations.total_revenue | Product Revenue |
| number_registrations | productRegistrations.total_number_registrations | Number of Product Registrations |
| number_cancellations | productRegistrations.total_number_cancellations | Number of Product Cancellations |
| number_transactions | productRegistrations.count | Number of Product Transactions |
| product_types_names | productTypes.all_names | Product Types Names |
| categories_names | categories.all_names | Categories Names |
| Name | Description |
|---|---|
| total_revenue | Total Revenue |
| total_number_registrations | Number of Registrations |
| total_number_cancellations | Number of Cancellations |
| Name | Description |
|---|---|
| id | ID |
| status | Status |
| product_id | Product ID |
| price_before_discount | Price before discount |
| amount_discounted | Amount discounted |
| price_after_discount | Price after discount |
| transaction_at | Transaction Date & Time |
| is_cancellation_transaction | Is Cancellation |
| cancellation_id | Cancellation ID |
| is_paid | Paid |
| cart_id | Cart ID |
| user_id | User ID |
| package_registration | Free registration for a package product |
| package_id | Package id, in case product is part of package |
| is_expired | Is expired registration |
| expired_at | Expired at |
| completed | Is Completed |
| completed_at | Completed at |
| discount_name | Discount Name |
| discount_remote_id | Discount Remote ID |
| discount_code | Discount Code |
| custom_questions_answers | Custom Questions Answers |
| edit_history | Edit History |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| user | user | User |
| assetAccesses | assetAccess | Asset accesses |
| earnedCredits | earnedCredit | Earned Credits |
| payment | payment | Payment |
| quizResults | quizResult | Quiz Results |
| cart | cart | Cart |
| Name | Actual value | Description |
|---|---|---|
| number_webinars_viewed | assetAccesses.total_number_webinars_viewed | Number Of Webinars Viewed |
| number_quizzes_attempts | quizResults.total_number_quiz_attempts | Number Of Quizzes Attempts |
| number_quizzes_taken | quizResults.total_number_quizzes_taken | Number Of Quizzes Taken |
| number_quizzes_passed | quizResults.total_number_quizzes_passed | Number Of Quizzes Passed |
| number_earned_credits | earnedCredits.total_number_earned_credits | Product Revenue |
| product_completion | assetAccesses.product_completion | Product Completion |
| discount_name | cart.discount_name | Discount Name |
| discount_remote_id | cart.discount_remote_id | Discount Remote ID |
| discount_code | cart.discount_code | Discount Code |
| Name | Description |
|---|---|
| total_before_discounts | Revenue Before Discount |
| total_amount_discounted | Total Discounts |
| total_revenue | Total Revenue |
| total_earned_credits | Total Number Earned Credits |
| total_number_webinars_viewed | Total Number Of Webinars Viewed |
| total_number_quizzes_attempts | Total Number Of Quizzes Attempts |
| total_number_quizzes_taken | Total Number Of Quizzes Taken |
| total_number_quizzes_passed | Total Number Of Quizzes Passed |
| total_number_earned_credits | Total Number Earned Credits |
| total_number_free_registrations | Total Number Free Registrations |
| total_number_paid_registrations | Total Number Paid Registrations |
| total_number_registrations | Total Number Registrations |
| total_number_cancellations | Total Number Cancellations |
| Name | Description |
|---|---|
| id | Product Type ID |
| name | Product Type Name |
| Name | Resource | Description |
|---|---|---|
| products | product | Related Products |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| all_names | Names |
| Name | Description |
|---|---|
| id | Quiz ID |
| asset_id | Asset ID |
| product_id | Product ID |
| quiz_title | Title |
| passing_threshold | Passing Threshold |
| created_at | Product ID |
| user_asset_accesses.access_datetime | Access datetime |
| number_taken | Number of times the quiz was taken |
| number_passed | Number of times the quiz was passed |
| number_failed | Number of times the quiz was failed |
| avg_score | Average score |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| quizAccesses | quizAccess | Asset accesses |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| average_score | Average score on test |
| Name | Description |
|---|---|
| id | Access ID |
| product_id | Product ID |
| access_datetime | Access Datetime |
| minutes_accessed | Minutes Accessed |
| user_id | |
| asset_id | |
| finished |
| Name | Resource | Description |
|---|---|---|
| user | quizUser | Registered User |
| products | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | ID |
| question | |
| question_text | |
| answer | |
| answer_text | |
| correct | |
| user_asset_access_id |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| product_id | Product ID |
| asset_id | Asset ID |
| user_id | User ID |
| title | Quiz Title |
| passed | Final Pass/Fail Status |
| score | Final Score |
| passing_threshold | Passing threshold |
| required_score | Required Score |
| number_attempts | Number Of Attempts |
| quiz_taken_at | Quiz Taken Date & Time |
| cart_product_id |
| Name | Resource | Description |
|---|---|---|
| user | user | User |
| product | product | Product |
| answers | quizAnswer | Answers |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|---|
| total_number_quiz_attempts | Number Of Quiz Attempts |
| total_number_quizzes_taken | Number Of Quizzes Taken |
| total_number_quizzes_passed | Total Quizzes Passed |
| average_score | Average score |
| Name | Description |
|---|---|
| id | User ID |
| firstname | First Name |
| lastname | Last Name |
| company | Company |
| title | Title |
| address | Address |
| address2 | Address 2 |
| city | City |
| state | State |
| zip | Zip |
| Name | Resource | Description |
|---|
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | ID |
| name | Name |
| title | Title |
| bio | |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | Survey ID |
| title | Title |
| description | Description |
| product_title | Product Title |
| product_id | Product ID |
| search | For Search |
| Name | Resource | Description |
|---|
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | ID |
| question_type | |
| question_text | |
| question_num | |
| likert_sub_question_num | |
| likert_sub_question_text | |
| answer_num | |
| answer_text | |
| user_asset_access_id |
| Name | Resource | Description |
|---|
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | ID |
| access_datetime | Survey Submitted DateTime |
| minutes_accessed | Minutes Accessed |
| user_id | |
| product_id | Product ID |
| asset_id | Component ID |
| finished | |
| title | Survey Title |
| Name | Resource | Description |
|---|---|---|
| user | user | User |
| product | product | Product |
| answers | surveyAnswer | Answers |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|
| Name | Description |
|---|---|
| id | ID |
| firstname | First Name |
| lastname | Last Name |
| company | Company |
| title | Title |
| address | Address |
| address2 | Address 2 |
| city | City |
| state | State |
| zip | Zip |
| country | Country |
| phone | Phone |
| created_at | Account Created |
| member_id | AMS Member ID |
| member_type | User Type |
| activated | Activated Account |
| search | For Search |
| search2 | For Search (test) |
| custom_fields_labeled | Custom Fields |
| custom_fields | Custom Fields |
| updated_at | Updated At |
| logged_in_at | Most Recent Login |
| Name | Resource | Description |
|---|---|---|
| productRegistrations | productRegistration | Product Registrations |
| Name | Actual value | Description |
|---|---|---|
| revenue | productRegistrations.total_revenue | User Revenue |
| number_of_registrations | productRegistrations.count | Number of Registrations |
| total_earned_credits | productRegistrations.total_earned_credits | Total Earned Credits |
| Name | Description |
|---|---|
| engagement_percentage | User Engagement Percentage |
| Name | Description |
|---|---|
| id | Web Content ID |
| asset_id | Component ID |
| product_id | Product ID |
| webinar_title | Component Title |
| content_type | Content Type |
| duration | Duration (minutes) |
| type | Live/On-Demand |
| start_at | Start Date/Time |
| end_at | End Date/Time |
| archive_recording_at | Recording Date/Time |
| Name | Resource | Description |
|---|---|---|
| product | product | Product |
| Name | Actual value | Description |
|---|
| Name | Description |
|---|