< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/organizationElectionMetricsSyncOut (Jump to "Try It Now")

Required Parameters

Parameter name Value Description
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
voter_device_id string An 88 character unique identifier linked to a voter record on the server. If not provided, a new voter_device_id (and voter entry) will be generated, and the voter_device_id will be returned.

Optional Parameters

Parameter name Value Description
starting_date_as_integer integer The earliest date for the batch we are retrieving. Format: YYYYMMDD (ex/ 20200131) (Default is 3 months ago)
ending_date_as_integer integer Retrieve data through this date. Format: YYYYMMDD (ex/ 20200228) (Default is right now.)
return_csv_format boolean If set to true, return results in CSV format instead of JSON.

Response

[{
  "id": integer,
  "authenticated_visitors_total": integer,
  "election_day_text": string,
  "entrants_friends_only_positions": integer,
  "entrants_friends_only_positions_with_comments": integer,
  "entrants_public_positions": integer,
  "entrants_public_positions_with_comments": integer,
  "entrants_took_position": integer,
  "entrants_visited_ballot": integer,
  "followers_at_time_of_election": integer,
  "followers_friends_only_positions": integer,
  "followers_friends_only_positions_with_comments": integer,
  "followers_public_positions": integer,
  "followers_public_positions_with_comments": integer,
  "followers_took_position": integer,
  "followers_visited_ballot": integer,
  "google_civic_election_id": integer,
  "new_auto_followers": integer,
  "new_followers": integer,
  "organization_we_vote_id": integer,
  "visitors_total": integer,
  "voter_guide_entrants": integer,
}]

Try It Now: API Variables

Allow people with Analytics Admin authority to retrieve election metrics for one organization information for data analysis purposes.

Parameter name Value  
voter_device_id:
starting_date_as_integer:
ending_date_as_integer:
return_csv_format: True
False

(opens in new window)