< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/sitewideVoterMetricsSyncOut (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,
  "actions_count": integer,
  "ballot_visited": integer,
  "comments_entered_friends_only": integer,
  "comments_entered_public": integer,
  "days_visited": integer,
  "elections_viewed": integer,
  "entered_full_address": integer,
  "issues_followed": integer,
  "last_action_date": integer,
  "last_calculated_date_as_integer": integer,
  "organizations_followed": integer,
  "positions_entered_friends_only": integer,
  "positions_entered_public": integer,
  "seconds_on_site": integer,
  "signed_in_facebook": integer,
  "signed_in_twitter": integer,
  "signed_in_with_email": integer,
  "signed_in_with_sms_phone_number": integer,
  "time_until_sign_in": integer,
  "voter_guides_viewed": integer,
  "voter_we_vote_id": integer,
  "welcome_visited": integer,
}]

Try It Now: API Variables

Allow people with Analytics Admin authority to retrieve voter metrics 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)