VoteCounts: Used to report on
Contest vote counts.
Counts lets you filter vote counts by device characteristics, or by the type
of ballot or write-in. It also lets you link the counts to a defined GpUnit
entity, such as for a country.
Elements
The following table describes the elements for Counts:
Element
Multiplicity
Type
Description
GpUnitId
0 or 1
IDREF
Unique identifier for a
GpUnit
element. Used to associate counts with a geopolitical unit, such as a
precinct, county, or township.
IsSuppressedForPrivacy
0 or 1
boolean
Indicates whether votes are suppressed for voter privacy. If this
isn't present, the default value is false.
The type of count being used as a filter on the vote counts, such as
election day or early voting.
If the type for a Count item isn't listed in the
CountItemType enumeration, set Type to
other and include the custom type in
OtherType.
OtherType
0 or 1
string
Used when Type is other to specify what's
being counted.
SummaryCounts
Use SummaryCounts to represent contest-wide or geopolitical unit-wide summary
counts.
SummaryCounts includes Counts as
an extension base and therefore inherits the elements from
Counts. However, SummaryCounts isn't a type of Counts, but is instead
included directly for Contest and
GpUnit.
SummaryCounts can be used to provide a geographical scope-wide summary of
miscellaneous counts associated with a Contest, such as the total number of
ballots cast, total number of overvotes, undervotes, and write-ins.
SummaryCounts can optionally reference GpUnit elements defined for
lower-level reporting units. This lets you associate summary counts with other
lower-level reporting units within the scope of the contest.
SummaryCounts can also be used to provide summary counts specific to a
GpUnit. For example, a GpUnit defined for a country can include
SummaryCounts to provide a summary count. SummaryCounts, in this case,
doesn't include the GpUnitId element in Counts.
In Counts, if the type of count item isn't listed in the enumeration
CountItemType, use other and
include the custom type in OtherType.
Elements
The following table describes the elements for SummaryCounts:
The following table describes the elements for VoteCounts:
Element
Multiplicity
Type
Description
Count
0 or 1
float
The count of contest votes cast, as a number between 0 and 100. In
special cases, the count can include a fractional component. For
example, report 14.2% as 14.2 and not 0.142.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-21 UTC."],[[["\u003cp\u003e\u003ccode\u003eCounts\u003c/code\u003e is an abstract entity serving as a base for \u003ccode\u003eSummaryCounts\u003c/code\u003e and \u003ccode\u003eVoteCounts\u003c/code\u003e, specifically designed for election results data feeds and not used with pre-election or officeholder feeds.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSummaryCounts\u003c/code\u003e is used to report summary vote counts for contests and geopolitical units, offering insights into metrics like total ballots cast, outstanding, rejected, overvotes, undervotes, and write-ins.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eVoteCounts\u003c/code\u003e provides specific vote counts for ballot selections within a contest, incorporating details like geopolitical unit, count type, and the actual vote count, which can be a whole number or a percentage represented as a decimal.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCounts\u003c/code\u003e enables filtering vote counts by device characteristics, ballot types, write-ins, and geopolitical unit association, while also containing elements like \u003ccode\u003eGpUnitId\u003c/code\u003e, \u003ccode\u003eIsSuppressedForPrivacy\u003c/code\u003e, \u003ccode\u003eType\u003c/code\u003e, and \u003ccode\u003eOtherType\u003c/code\u003e for detailed reporting.\u003c/p\u003e\n"]]],[],null,["| **Note:** This entity is only used with election results feeds. It isn't used with the pre-election data or officeholder feed types.\n\n`Counts` isn't used or referenced directly. Instead, it's only used as an\nextension base for the following entities:\n\n- [`SummaryCounts`](/civics-data/reference/counts#summary-counts): Used to report on [`Contest`](/civics-data/reference/contest) and geopolitical unit ([`GpUnit`](/civics-data/reference/gp-unit)) summary vote counts.\n- [`VoteCounts`](/civics-data/reference/counts#vote-counts): Used to report on `Contest` vote counts.\n\n`Counts` lets you filter vote counts by device characteristics, or by the type\nof ballot or write-in. It also lets you link the counts to a defined `GpUnit`\nentity, such as for a country.\n\nElements\n\nThe following table describes the elements for `Counts`:\n\n| Element | Multiplicity | Type | Description |\n|--------------------------|--------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `GpUnitId` | 0 or 1 | `IDREF` | Unique identifier for a [`GpUnit`](/civics-data/reference/gp-unit) element. Used to associate counts with a geopolitical unit, such as a precinct, county, or township. |\n| `IsSuppressedForPrivacy` | 0 or 1 | `boolean` | Indicates whether votes are suppressed for voter privacy. If this isn't present, the default value is `false`. |\n| `Type` | 0 or 1 | [`CountItemType`](/civics-data/reference/count-item-type) | The type of count being used as a filter on the vote counts, such as election day or early voting. If the type for a `Count` item isn't listed in the `CountItemType` enumeration, set `Type` to `other` and include the custom type in `OtherType`. |\n| `OtherType` | 0 or 1 | `string` | Used when `Type` is `other` to specify what's being counted. |\n\nSummaryCounts\n\nUse `SummaryCounts` to represent contest-wide or geopolitical unit-wide summary\ncounts.\n| **Note:** This entity is only used with election results feeds. It isn't used with the pre-election data or officeholder feed types.\n\n`SummaryCounts` includes [`Counts`](/civics-data/reference/counts) as\nan extension base and therefore inherits the elements from\n`Counts`. However, `SummaryCounts` isn't a type of `Counts`, but is instead\nincluded directly for [`Contest`](/civics-data/reference/contest) and\n[`GpUnit`](/civics-data/reference/gp-unit).\n\n`SummaryCounts` can be used to provide a geographical scope-wide summary of\nmiscellaneous counts associated with a `Contest`, such as the total number of\nballots cast, total number of overvotes, undervotes, and write-ins.\n`SummaryCounts` can optionally reference `GpUnit` elements defined for\nlower-level reporting units. This lets you associate summary counts with other\nlower-level reporting units within the scope of the contest.\n\n`SummaryCounts` can also be used to provide summary counts specific to a\n`GpUnit`. For example, a `GpUnit` defined for a country can include\n`SummaryCounts` to provide a summary count. `SummaryCounts`, in this case,\ndoesn't include the `GpUnitId` element in `Counts`.\n\nIn `Counts`, if the type of count item isn't listed in the enumeration\n[`CountItemType`](/civics-data/reference/count-item-type), use `other` and\ninclude the custom type in `OtherType`.\n\nElements\n\nThe following table describes the elements for `SummaryCounts`:\n\n| Element | Multiplicity | Type | Description |\n|----------------------|--------------|-----------|------------------------------------|\n| `BallotsCast` | 0 or 1 | `integer` | Number of ballots cast. |\n| `BallotsOutstanding` | 0 or 1 | `integer` | Number of ballots not yet counted. |\n| `BallotsRejected` | 0 or 1 | `integer` | Number of ballots rejected. |\n| `Overvotes` | 0 or 1 | `integer` | Number of overvotes. |\n| `Undervotes` | 0 or 1 | `integer` | Number of undervotes. |\n| `WriteIns` | 0 or 1 | `integer` | Number of write-ins. |\n\nExamples \n\nXML \n\n```xml\n \u003cSummaryCounts\u003e\n \u003cBallotsCast\u003e2089540\u003c/BallotsCast\u003e\n \u003cWriteIns\u003e2087\u003c/WriteIns\u003e\n \u003c/SummaryCounts\u003e\n```\n\nJSON \n\n```json\n \"SummaryCounts\": [\n {\n \"BallotsCast\": \"2089540\",\n \"WriteIns\": \"2087\"\n }\n ]\n```\n\nVoteCounts\n\nUse `VoteCounts` to describe the vote counts for\n[`BallotSelection`](/civics-data/reference/ballot-selection) in a\n[`Contest`](/civics-data/reference/contest).\n| **Note:** This entity is only used with election results feeds. It isn't used with the pre-election data or officeholder feed types.\n\nElements\n\nThe following table describes the elements for `VoteCounts`:\n\n| Element | Multiplicity | Type | Description |\n|---------|--------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `Count` | 0 or 1 | `float` | The count of contest votes cast, as a number between 0 and 100. In special cases, the count can include a fractional component. For example, report 14.2% as `14.2` and not 0.142. For a list of supported types of vote counts, see [Result tabulation types](/civics-data/reference/count-item-type#result-tabulation-types). |\n\nExamples \n\nXML \n\n```xml\n \u003cVoteCounts\u003e\n \u003cGpUnitId\u003eru_001\u003c/GpUnitId\u003e\n \u003cType\u003etotal\u003c/Type\u003e\n \u003cCount\u003e6173433\u003c/Count\u003e\n \u003c/VoteCounts\u003e\n \u003cVoteCounts\u003e\n \u003cGpUnitId\u003eru_001\u003c/GpUnitId\u003e\n \u003cType\u003eother\u003c/Type\u003e\n \u003cOtherType\u003eprojected-vote-percent\u003c/OtherType\u003e\n \u003cCount\u003e22.3\u003c/Count\u003e\n \u003c/VoteCounts\u003e\n```\n\nJSON \n\n```json\n \"VoteCounts\": [\n {\n \"GpUnitId\": \"ru_001\",\n \"Type\": \"total\",\n \"Count\": \"6173433\"\n },\n {\n \"GpUnitId\": \"ru_001\",\n \"Type\": \"other\",\n \"OtherType\": \"projected-vote-percent\",\n \"Count\": \"22.3\"\n }\n ]\n```"]]