Changes in changelog and client.py

Flowminder · Jul 3, 2019 · ad2453a · ad2453a
1 parent 6e32807
commit ad2453a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ All notable changes to FlowKit will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
-
+- FlowAPI's 'joined_spatial_aggregate' endpoint now exposes event counts.[#992](https://github.com/Flowminder/FlowKit/issues/992)
 ### Added
 
 
@@ -28,7 +28,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Added a `Geography` query class, to get geography data for a spatial unit.
 - FlowAPI's 'joined_spatial_aggregate' endpoint now exposes unique location counts.[#949](https://github.com/Flowminder/FlowKit/issues/949)
 - FlowAPI's 'joined_spatial_aggregate' endpoint now exposes subscriber degree.[#969](https://github.com/Flowminder/FlowKit/issues/969)
-- FlowAPI's 'joined_spatial_aggregate' endpoint now exposes event counts.[#992](https://github.com/Flowminder/FlowKit/issues/992)
 - Flowdb now contains an auxiliary table to record outcomes of queries that can be run as part of the regular ETL process [#988](https://github.com/Flowminder/FlowKit/issues/988)
 
 ### Changed

diff --git a/docs/source/developer/developer.md b/docs/source/developer/developer.md
@@ -138,7 +138,7 @@ At present, the following query types are accessible through FlowAPI:
 
 -`event_count`
 
-    Count of event for individual subscribers in a time period.
+    Count of events (optionally of specific types) for individual subscribers in a time period.
 
 ### FlowAPI Access tokens
 

diff --git a/flowclient/flowclient/client.py b/flowclient/flowclient/client.py
@@ -1343,8 +1343,8 @@ def event_count(
     direction : {"in", "out", "both"}, default "both"
         Optionally, include only ingoing or outbound calls/texts. Can be one of "in", "out" or "both".
     event_types : list of str, optional
-        The event types for which to return available dates (for example: ["calls", "sms"]).
-        If None, return available dates for all available event types.
+        The event types to include in the count (for example: ["calls", "sms"]).
+        If None, include all event types in the count.
     subscriber_subset : dict or None, default None
         Subset of subscribers to include in event counts. Must be None
         (= all subscribers) or a dictionary with the specification of a