< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/analyticsActionSyncOut (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,
  "action_constant": string,
  "action_constant_text": string,
  "authentication_failed_twice": string,
  "ballot_item_we_vote_id": string,
  "date_as_integer": integer,
  "exact_time": string,
  "first_visit_today": boolean,
  "google_civic_election_id": string,
  "is_bot": boolean,
  "is_desktop": boolean,
  "is_mobile": boolean,
  "is_signed_in": boolean,
  "is_tablet": boolean,
  "organization_we_vote_id": string,
  "state_code": string,
  "user_agent": string,
  "voter_we_vote_id": string,
}]

Try It Now: API Variables

Allow people with Analytics Admin authority to retrieve raw Analytics Action information for data analysis purposes. The definitions of the ACTION constants ('action_constant') are here: https://github.com/wevote/WeVoteServer/blob/develop/analytics/models.py

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

(opens in new window)