API v1.1.1

change log

Details

  • request method: GET
  • return format is json

Endpoints

Subjects:
Grades:
  • List: https://api.edreports.org/api/v1/taxonomies_grades - view data
    Parameters:
    • key - string - your unique access key provided by EdReports team

    Return:

    • version number
    • results_total
    • results_returned
    • data - array of objects with fields:
      • id - Unique entity identifier
      • code - Internal Code
      • name - Short Name
      • description - Long Name / Description
Publishers:
  • List: https://api.edreports.org/api/v1/publishers - view data
    Parameters:
    • key - string - your unique access key provided by EdReports team
    • page - int - Enables pagination and sets current page number
    • per-page - int - Sets the number of elements per page

    Return:

    • version number
    • results_total
    • results_returned
    • page
    • data - array of objects with fields:
      • id - Unique Publisher Identifier
      • publisher - Publisher Name
Series:
  • List: https://api.edreports.org/api/v1/series - view data
    Parameters:
    • key - string - your unique access key provided by EdReports team
    • page - int - Enables pagination and sets current page number
    • per-page - int - Sets the number of elements per page
    • publisher_id - int - Publisher ID
    • subject_taxonomy_id - int - Subject ID
    • is_state_specific - string - Is State Specific - "none" or state code

    Return:

    • version number
    • results_total
    • results_returned
    • page
    • data - array of objects with fields:
      • id - Unique Series Taxonomy Identifier
      • title - Title
      • grades_description - String version of the grades
      • publisher_id - Publisher Unique Identifier
      • subject_taxonomy_id - Subject Taxonomy ID
      • edition - Edition
      • is_state_specific - Is State Specific
  • Detail: https://api.edreports.org/api/v1/series/[ENTITY ID] - view data

    Return: object with fields:

    • id - Unique Identifier
    • title - Title
    • series_url
    • grades_description - String version of the grades
    • publisher_id - Publisher Unique Identifier
    • edition - Edition's Year
    • subject_taxonomy_id - Subject Taxonomy Unique Identifier
    • image - Full Url to the image
    • insights_from_reviewers - Insights - HTML
    • additional_notes - Notes - HTML
    • additional_notes_open_source - Notes if the series is open source
    • series_date - Date
    • is_derivative_product - Is Derivative Product? - Yes / No
    • derivative_product_note - Derivative Product Note
    • is_state_specific - Is State Specific? - "none" or state code when the series is state specific
    • state_specific_note - State Specific Note - notes for when the series is state specific (is_state_specific is different than "none")
    • delivery_method - Array containing the types of delivery methods
    • is_open_education_resource - Is Open Education Resource? - Yes / No
    • grade_k2_summary - Grade Band K-2 Report
    • grade_k2_gateway_1_rating - Grade Band K-2 G1 rating
    • grade_k2_gateway_2_rating - Grade Band K-2 G2 rating
    • grade_k2_ccss_rating - Grade Band K-2 Alignment to CCSS (Gateway 1 + 2) rating
    • grade_k2_gateway_3_rating - Grade Band K-2 G3 rating
    • grade_35_summary - Grade Band 3-5 Report
    • grade_35_gateway_1_rating - Grade Band 3-5 G1 rating
    • grade_35_gateway_2_rating - Grade Band 3-5 G2 rating
    • grade_35_ccss_rating - Grade Band 3-5 Alignment to CCSS (Gateway 1 + 2) rating
    • grade_35_gateway_3_rating - Grade Band 3-5 G3 rating
    • grade_68_summary - Grade Band 6-8 Report
    • grade_68_gateway_1_rating - Grade Band 6-8 G1 rating
    • grade_68_gateway_2_rating - Grade Band 6-8 G2 rating
    • grade_68_ccss_rating - Grade Band 6-8 Alignment to CCSS (Gateway 1 + 2) rating
    • grade_68_gateway_3_rating - Grade Band 6-8 G3 rating
    • grade_912_summary - Grade Band High School Report
    • publisher_responses - Array of objects with responses provided by the publisher
Reports:
  • List: https://api.edreports.org/api/v1/reports - view data
    Parameters:
    • key - string - your unique access key provided by EdReports team
    • page - int - Enables pagination and sets current page number
    • per-page - int - Sets the number of elements per page
    • publisher_id - int - Publisher ID
    • series_id - int - Series ID
    • subject_taxonomy_id - int - Subject ID
    • grade_taxonomy_id - int - Grade ID

    Return:

    • version number
    • results_total
    • results_returned
    • page
    • data - array of objects with fields:
      • id - Unique Report Identifier
      • title - Title
      • report_date - Report Date
      • subject_taxonomy_id - Subject ID
      • grade_taxonomy_id - Grade ID
      • series_id - Series ID
  • Detail: https://api.edreports.org/api/v1/reports/[ENTITY ID] - view data

    Return: object with fields:

    Important!

    The fields after "focus" field, are different for each report type. Each type of report can have different components, criterions and indicators

    The fields returned by the API for each report match the fields returned by the API for that specific report type

    • id - Unique Identifier
    • title - Title
    • report_date
    • grade_taxonomy_id
    • subject_taxonomy_id - Subject Taxonomy Unique Identifier
    • reviewed_date
    • gateway_1_points
    • gateway_1_rating
    • gateway_1_report
    • gateway_2_points
    • gateway_2_rating
    • gateway_2_report
    • gateway_3_points
    • gateway_3_rating
    • meta_title
    • meta_description
    • report_type - Unique Identifier of the type of report
    • series_id
    • report_url
    • gateway_2_no_review_copy
    • gateway_3_no_review_copy
    • meta_image
    • focus
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 1a
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 1a.i
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 1b
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 1b.i
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • coherence
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 1c1f
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 1c
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 1d
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 1e
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 1f
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • rigor-and-balance
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 2a2d
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 2a
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2b
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2c
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2d
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • mathematical-practice-content-connections
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 2e2g
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 2e
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2f
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2g
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 2g.i
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2g.ii
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 2g.iii
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • alignment-to-common-core
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
    • usability
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3a3e
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3a
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3b
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3c
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3d
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3e
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3f3l
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3f
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3g
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3h
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3i
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3j
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3k
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3l
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3m3q
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3m
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3n
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3o
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3p
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3p.i
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3p.ii
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3q
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3r3y
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3r
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3s
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3t
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3u
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3v
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3w
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • points - The score / number of points
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • report - The report for current data
    • 3x
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3y
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3z3ad
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3z
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3aa
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3ab
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3ac
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • 3ad
      • code
      • type - The type of data displayed by the field (component, criterion or indicator)
      • report - The report for current data
    • isbns - Array of isbns set for current report
Report Types:
  • List: https://api.edreports.org/api/v1/report_types - view data
    Parameters:
    • key - string - your unique access key provided by EdReports team

    Return:

    • version number
    • results_total
    • results_returned
    • data - array of objects with fields:
      • id - Unique ReportType Identifier
      • name - Name
      • grade_taxonomy_ids - Array of Grade Taxonomy IDs
  • Detail: https://api.edreports.org/api/v1/report_types/[ENTITY ID] - view data

    Return: object with fields:

    • id - Unique Identifier
    • name - Name
    • grade_taxonomy_ids - Array of Grade Taxonomy Ids
    • gateway_1_title
    • gateway_1_descriptive_name_1
    • gateway_1_descriptive_name_2
    • gateway_1_descriptive_name_3
    • gateway_1_intervals
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • min
      • max
      • display
    • gateway_2_title
    • gateway_2_descriptive_name_1
    • gateway_2_descriptive_name_2
    • gateway_2_descriptive_name_3
    • gateway_2_intervals
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • min
      • max
      • display
    • gateway_3_title
    • gateway_3_intervals
      • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
      • min
      • max
      • display
    • data_structure
      • type - The type of data displayed by the field (component, criterion or indicator)
      • code
      • name - Name
      • description
      • intervals - Array of intervals to establish the rating
        • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
        • min
        • max
        • display
      • has-report
      • childs - Array of sub data structures with the following fields
        • type - The type of data displayed by the field (component, criterion or indicator)
        • code
        • name - Name
        • description
        • intervals - Array of intervals to establish the rating
          • rating - Data rating based on the rules (meets, partially-meets or does-not-meet)
          • min
          • max
          • display
        • has-report
        • childs - Array of sub data structures with the following fields
          • type - The type of data displayed by the field (component, criterion or indicator)
          • code
          • name - Name
          • description
          • allowed_values
          • has-report
          • is-required
          • required-minimum-points