API Documentation
API Reference

API Reference

Query

FieldArgumentTypeDescription
data_A[MeasureDatum_A]
order[MeasureDatumSortInput_A!]
whereMeasureDatumFilterInput_A
data_B[MeasureDatum_B!]!

This query will return a collection of data points. Data can be limited to a specific state. For querying data associated with one or more specific health measures, use the “measures” query.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

stateString

A U.S. state postal code. Eg. “NY”. For national data use, “ALL”.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

datum_A[MeasureDatum_A]
metricIdInt!
order[MeasureDatumSortInput_A!]
whereMeasureDatumFilterInput_A
datum_BMeasureDatum_B

This query will return an individual data point. Data can be limited to a specific state. For querying data associated with one or more specific health measures, use the “measures” query.

measureDatumIdInt!

The id of an individual data record.

measure_AMeasure_A
metricIdInt!
measure_BMeasure_B

This query will return an individual measure. You must provide a “measureId” argument to specify which measure you are seeking.

measureIdInt!

The id of an individual measure.

measures_A[Measure_A]
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
measures_B[Measure_B!]!

This query will return a collection of measures. Use the “skip” and “take” parameters to paginate the data.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

populationCategories_A[PopulationCategory_A]
wherePopulationCategoryFilterInput_A
populationCategories_B[PopulationCategory_B!]!

This query will return a collection of population categories. Use the “skip” and “take” parameters to paginate the data.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

populationCategory_BPopulationCategory_B

This query will return an individual population category, such as “Age”. You must provide a “populationCategoryId” argument to specify which population category you are seeking.

populationCategoryIdInt!

The id of an individual population category.

population_APopulation_A
populationIdInt!
population_BPopulation_B

This query will return an individual population. You must provide a “populationId” argument to specify which population you are seeking.

populationIdInt!

The id of an individual population.

populations_A[Population_A]
order[PopulationSortInput_A!]
wherePopulationFilterInput_A
populations_B[Population_B!]!

This query will return a collection of populations. Use the “skip” and “take” parameters to paginate the data.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

reportTypes_A[ReportType_A]
order[ReportTypeSortInput_A!]
whereReportTypeFilterInput_A
report_AReport_A
editionIdInt!
report_BReport

This query will return an individual report. You must provide a “reportId” argument to specify which report you are seeking.

reportIdInt!

The id of an individual report.

reports_A[Report_A]
order[ReportSortInput_A!]
whereReportFilterInput_A
reports_B[Report!]!

This query will return a collection of reports. Use the “skip” and “take” parameters to paginate the data.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

source_ASource_A
sourceIdInt!
source_BSource_B

This query will return an individual data source. You must provide a “sourceId” argument to specify which population category you are seeking.

sourceIdInt!

The id of an individual source.

sources_A[Source_A]
order[SourceSortInput_A!]
whereSourceFilterInput_A
sources_B[Source_B!]!

This query will return a collection of data sources. Use the “skip” and “take” parameters to paginate the data.

skipInt

The number of items you would like to skip, useful for pagination of large data sets.

takeInt

The number of items you would like to retrieve, useful for pagination of large data sets.

Objects

DataNote_B

FieldArgumentTypeDescription
dataNoteIdID!
measureDatumMeasureDatum_B
noteString!

MeasureDataMissingReasonType_A

FieldArgumentTypeDescription
descriptionString
metricDataMissingReasonTypeIdInt!
metricDataMissings[MeasureDataMissing_A]
nameString

MeasureDataMissing_A

FieldArgumentTypeDescription
metricDataMeasureDatum_A
metricDataIdInt!
metricDataMissingIdInt!
metricDataMissingReasonTypeMeasureDataMissingReasonType_A
metricDataMissingReasonTypeIdInt!

MeasureDatum_A

FieldArgumentTypeDescription
dataNotes[MeasureDataMissingReasonType_A]
order[MeasureDataMissingReasonTypeSortInput_A!]
whereMeasureDataMissingReasonTypeFilterInput_A
dateLabelString
endDateDateTime_A
lowerCIFloat
measureMeasure_A
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
measureDatumIdID!
rankInt
scoreFloat
startDateDateTime_A
stateString
upperCIFloat
valueFloat

MeasureDatum_B

The data points for a measure.

FieldArgumentTypeDescription
dataNotes[DataNote_B!]

Information relevant to the MeasureDatum for instances in which data is not available, suppressed, or has other nuances to be taken into account.

dateLabelString

The date or time period from which the data is from.

endDateDate

The end date of the time period of the data. For data from a given year, endDate is set to “1/1/YYYY”. This field is useful for handling date ranges (i.e., startDate - endDate).

lowerCIFloat

The lower 95% confidence interval, where available. Not all measures or data years for a specific measure have confidence intervals available.

measureMeasure_B!

The name of the measure.

measureDatumIdID!

The ID unique to each data.

rankInt

The rank of each state’s value by healthiest (1) to least healthy (50).

startDateDate

The start date of the time period of the data. For data from a given year, startDate is set to “1/1/YYYY”. This field is useful for handling date ranges (i.e., startDate - endDate).

stateString

The two-letter postal code of a state. Note the United States value is labeled as “ALL”.

upperCIFloat

The upper 95% confidence interval, where available.

valueFloat

The value for a given measure, state, and data year.

Measure_A

FieldArgumentTypeDescription
data[MeasureDatum_A]
order[MeasureDatumSortInput_A!]
whereMeasureDatumFilterInput_A
descriptionString
formatString
isWeightPositiveString
measureIdID!
nameString
populationPopulation_A
precisionInt
sourceSource_A
subpopulations[Measure_A]
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
unitTypeString

Measure_B

Measures from the America’s Health Rankings platform that are indicators of or associated with population health.

FieldArgumentTypeDescription
data[MeasureDatum_B!]!

The data points for the measure.

descriptionString!

The description of the measure.

formatString

The value type of the measure data value field, such as “Percent”, “Currency”, or “Numeric”.

isWeightPositiveString

Indicates a positive association with health. For example, the measure ‘Exercise’ would return the value “Y” while Smoking would return the value “N”.

measureIdID!

The ID unique to the measure. Measures with the same ID are comparable over time.

nameString!

The name of the measure.

populationPopulation_B!

The population that the measure is for, such as “Hispanic” or “Ages 18-24”.

precisionInt!

The precision of the measure data value field, indicating how many decimal places data should be displayed.

sourceSource_B

The original source of the measure's data.

subpopulations[Measure_B!]!

Measures pertaining to slices of the population - subpopulations. Only "root" measures have subpopulations. Note that some subpopulations are treated as root measures in this data set if they are featured in Health of Women and Children or Senior reports.

unitTypeString!

The description of the measure’s units, typically a shortened version of description. For example, “Deaths per 100,000 population.”

PopulationCategory_A

FieldArgumentTypeDescription
nameString
populationCategoryIdInt!
populations[Population_A]
order[PopulationSortInput_A!]
wherePopulationFilterInput_A

PopulationCategory_B

The Population Category organizes populations into categories such as race, age, gender, income, and education.

FieldArgumentTypeDescription
nameString!

The name of the population category.

populationCategoryIdID!

The ID of the population category.

populations[Population_B!]!

The populations associated with each category.

Population_A

FieldArgumentTypeDescription
measures[Measure_A]
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
nameString
populationCategoryPopulationCategory_A
wherePopulationCategoryFilterInput_A
populationIdID!

Population_B

Population describes which segment of the population the measure is describing such as “Hispanic” or “Ages 18-24”. This is a property of subpopulations only.

FieldArgumentTypeDescription
measures[Measure_B!]!

The name of the measure.

nameString!

The name of the population.

populationCategoryPopulationCategory_B!

The category of the population group, such as “Race” or “Age”.

populationIdID!

The ID of the population.

Report

FieldArgumentTypeDescription
liveOnDate!

The Report publish date

measures[Measure_B!]!
nameString!

The name of the report

reportIdID!

The ID of the Report

reportTypeString!

The type of report

slugString!

ReportMeasureType_A

FieldArgumentTypeDescription
endDateDateTime_A
measureMeasure_A
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
measureIdInt!
reportReport_A
order[ReportSortInput_A!]
whereReportFilterInput_A
reportIdInt!
weightFloat

ReportType_A

FieldArgumentTypeDescription
nameString
reportTypeIdInt!
reports[Report_A]
order[ReportSortInput_A!]
whereReportFilterInput_A

Report_A

FieldArgumentTypeDescription
nameString
releaseDateInt!
reportIdInt!
reportMeasures[ReportMeasureType_A]
order[ReportMeasureTypeSortInput_A!]
whereReportMeasureTypeFilterInput_A
reportTypeReportType_A
reportTypeIdInt!

Source_A

FieldArgumentTypeDescription
measures[Measure_A]
order[MeasureSortInput_A!]
whereMeasureFilterInput_A
nameString
sourceIdInt!

Source_B

The primary Source of the data. All data presented on the America’s Health Rankings platform is secondary data, except for the ‘state rankings’ index measures.

FieldArgumentTypeDescription
measures[Measure_B!]!

The name of the measure.

nameString!

The name of the original data source.

sourceIdID!

The ID of the source.

Inputs

BooleanOperationFilterInput_A

FieldTypeDescription
eqBoolean
neqBoolean

ListFilterInputTypeOfMeasureDataMissingFilterInput_A

FieldTypeDescription
allMeasureDataMissingFilterInput_A
anyBoolean
noneMeasureDataMissingFilterInput_A
someMeasureDataMissingFilterInput_A

ListFilterInputTypeOfMeasureDatumFilterInput_A

FieldTypeDescription
allMeasureDatumFilterInput_A
anyBoolean
noneMeasureDatumFilterInput_A
someMeasureDatumFilterInput_A

ListFilterInputTypeOfMeasureFilterInput_A

FieldTypeDescription
allMeasureFilterInput_A
anyBoolean
noneMeasureFilterInput_A
someMeasureFilterInput_A

ListFilterInputTypeOfPopulationFilterInput_A

FieldTypeDescription
allPopulationFilterInput_A
anyBoolean
nonePopulationFilterInput_A
somePopulationFilterInput_A

ListFilterInputTypeOfReportFilterInput_A

FieldTypeDescription
allReportFilterInput_A
anyBoolean
noneReportFilterInput_A
someReportFilterInput_A

ListFilterInputTypeOfReportMeasureTypeFilterInput_A

FieldTypeDescription
allReportMeasureTypeFilterInput_A
anyBoolean
noneReportMeasureTypeFilterInput_A
someReportMeasureTypeFilterInput_A

MeasureDataMissingFilterInput_A

FieldTypeDescription
and[MeasureDataMissingFilterInput_A!]
metricDataMeasureDatumFilterInput_A
metricDataMissingReasonTypeMeasureDataMissingReasonTypeFilterInput_A
or[MeasureDataMissingFilterInput_A!]

MeasureDataMissingReasonTypeFilterInput_A

FieldTypeDescription
and[MeasureDataMissingReasonTypeFilterInput_A!]
descriptionStringOperationFilterInput_A
metricDataMissingsListFilterInputTypeOfMeasureDataMissingFilterInput_A
nameStringOperationFilterInput_A
or[MeasureDataMissingReasonTypeFilterInput_A!]

MeasureDataMissingReasonTypeSortInput_A

FieldTypeDescription
descriptionSortEnumType_A
metricDataMissingReasonTypeIdSortEnumType_A
nameSortEnumType_A

MeasureDatumFilterInput_A

FieldTypeDescription
and[MeasureDatumFilterInput_A!]
dataNotesListFilterInputTypeOfMeasureDataMissingFilterInput_A
dateLabelStringOperationFilterInput_A
measureMeasureFilterInput_A
or[MeasureDatumFilterInput_A!]
stateStringOperationFilterInput_A

MeasureDatumSortInput_A

FieldTypeDescription
dateLabelSortEnumType_A
endDateSortEnumType_A
lowerCISortEnumType_A
measureMeasureSortInput_A
measureDatumIdSortEnumType_A
measureIdSortEnumType_A
rankSortEnumType_A
startDateSortEnumType_A
stateSortEnumType_A
upperCISortEnumType_A
valueSortEnumType_A

MeasureFilterInput_A

FieldTypeDescription
and[MeasureFilterInput_A!]
dataListFilterInputTypeOfMeasureDatumFilterInput_A
descriptionStringOperationFilterInput_A
formatStringOperationFilterInput_A
isWeightPositiveStringOperationFilterInput_A
nameStringOperationFilterInput_A
or[MeasureFilterInput_A!]
populationPopulationFilterInput_A
sourceSourceFilterInput_A
unitTypeStringOperationFilterInput_A

MeasureSortInput_A

FieldTypeDescription
descriptionSortEnumType_A
formatSortEnumType_A
isWeightPositiveSortEnumType_A
measureCategoryIdSortEnumType_A
measureIdSortEnumType_A
nameSortEnumType_A
populationPopulationSortInput_A
populationIdSortEnumType_A
precisionSortEnumType_A
sourceSourceSortInput_A
sourceIdSortEnumType_A
unitTypeSortEnumType_A

PopulationCategoryFilterInput_A

FieldTypeDescription
and[PopulationCategoryFilterInput_A!]
nameStringOperationFilterInput_A
or[PopulationCategoryFilterInput_A!]
populationsListFilterInputTypeOfPopulationFilterInput_A

PopulationFilterInput_A

FieldTypeDescription
and[PopulationFilterInput_A!]
measuresListFilterInputTypeOfMeasureFilterInput_A
nameStringOperationFilterInput_A
or[PopulationFilterInput_A!]
populationCategoryPopulationCategoryFilterInput_A

PopulationSortInput_A

FieldTypeDescription
nameSortEnumType_A
populationCategoryIdSortEnumType_A
populationIdSortEnumType_A

ReportFilterInput_A

FieldTypeDescription
and[ReportFilterInput_A!]
nameStringOperationFilterInput_A
or[ReportFilterInput_A!]
reportMeasureTypesListFilterInputTypeOfReportMeasureTypeFilterInput_A
reportPathStringOperationFilterInput_A

ReportMeasureTypeFilterInput_A

FieldTypeDescription
and[ReportMeasureTypeFilterInput_A!]
measureMeasureFilterInput_A
or[ReportMeasureTypeFilterInput_A!]
reportReportFilterInput_A

ReportMeasureTypeSortInput_A

FieldTypeDescription
endDateSortEnumType_A
measureMeasureSortInput_A
measureIdSortEnumType_A
reportReportSortInput_A
reportIdSortEnumType_A
weightSortEnumType_A

ReportSortInput_A

FieldTypeDescription
nameSortEnumType_A
releaseDateSortEnumType_A
reportIdSortEnumType_A
reportPathSortEnumType_A
reportTypeIdSortEnumType_A

ReportTypeFilterInput_A

FieldTypeDescription
and[ReportTypeFilterInput_A!]
nameStringOperationFilterInput_A
or[ReportTypeFilterInput_A!]

ReportTypeSortInput_A

FieldTypeDescription
nameSortEnumType_A
reportTypeIdSortEnumType_A

SourceFilterInput_A

FieldTypeDescription
and[SourceFilterInput_A!]
metricsListFilterInputTypeOfMeasureFilterInput_A
nameStringOperationFilterInput_A
or[SourceFilterInput_A!]

SourceSortInput_A

FieldTypeDescription
nameSortEnumType_A
sourceIdSortEnumType_A

StringOperationFilterInput_A

FieldTypeDescription
and[StringOperationFilterInput_A!]
containsString
endsWithString
eqString
in[String]
ncontainsString
nendsWithString
neqString
nin[String]
nstartsWithString
or[StringOperationFilterInput_A!]
startsWithString

Enums

SortEnumType_A

ValueDescription
ASC
DESC

Scalars

Boolean

The Boolean scalar type represents true or false.

Date

Date custom scalar type

DateTime_A

The DateTime scalar represents an ISO-8601 compliant date time type.

Decimal_A

The built-in Decimal scalar type.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754 (opens in a new tab).

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Long_A

The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Short_A

The Short scalar type represents non-fractional signed whole 16-bit numeric values. Short can represent values between -(2^15) and 2^15 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.