-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Flowmachine event count #1023
Flowmachine event count #1023
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool.
Can we add this to docs/source/developer/developer.md
in the API Routes section around L77 as well please.
flowclient/flowclient/client.py
Outdated
start: str, | ||
stop: str, | ||
direction: str = "both", | ||
event_types: Union[None, List[str]] = None, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can actually write this as Optional[List[str]]
which is equivalent to Union[None, ..]
and maybe a bit clearer.
Co-Authored-By: Jonathan Gray <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #1023 +/- ##
==========================================
+ Coverage 93.93% 93.96% +0.02%
==========================================
Files 141 142 +1
Lines 6930 6957 +27
Branches 693 693
==========================================
+ Hits 6510 6537 +27
Misses 309 309
Partials 111 111
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #1023 +/- ##
==========================================
+ Coverage 93.93% 93.96% +0.02%
==========================================
Files 141 142 +1
Lines 6930 6957 +27
Branches 693 693
==========================================
+ Hits 6510 6537 +27
Misses 309 309
Partials 111 111
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #1023 +/- ##
==========================================
+ Coverage 93.93% 93.96% +0.02%
==========================================
Files 141 142 +1
Lines 6930 6957 +27
Branches 693 693
==========================================
+ Hits 6510 6537 +27
Misses 309 309
Partials 111 111
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of minor points, otherwise good.
CHANGELOG.md
Outdated
@@ -28,6 +28,7 @@ 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move up to unreleased pls.
docs/source/developer/developer.md
Outdated
@@ -136,6 +136,9 @@ At present, the following query types are accessible through FlowAPI: | |||
|
|||
Count of mobile phone cells per area active based on CDR traffic within a time period, broken down into time buckets. | |||
|
|||
-`event_count` | |||
|
|||
Count of event for individual subscribers in a time period. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Count of event for individual subscribers in a time period. | |
Count of events (optionally of specific types) for individual subscribers in a time period. |
flowclient/flowclient/client.py
Outdated
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"]). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The event types for which to return available dates (for example: ["calls", "sms"]). | |
The event types to include in the count (for example: ["calls", "sms"]). |
flowclient/flowclient/client.py
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If None, return available dates for all available event types. | |
If None, include all event types in the count. |
Closes #992
I have:
Event count values are exposed through FlowAPI's Joined Spatial Aggregate.