Skip to main content

Call Number

computed from raw feature: cortex.raw.calls

Description

Call number sums the number of calls.

Optional or required kwargs

  • start: (int, units: ms) the start time.
  • end: (int, units: ms) the end time.
  • resolution: (int, units: ms, default: 1 day = 86400000 ms) the resolution over which to compute features.
  • call_direction : (string, default: "all") whether to compute for incoming ("incoming"), outgoing ("outgoing"), or all ("all") types of calls.
  • (deprecated) incoming: (boolean, default: True) whether to compute for incoming (True) or outgoing (False) calls. Overrides call_direction if not None.

Data

  • timestamp: (int, units: ms) the start time of each bin of size kwargs['resolution'].
  • value: (int, units: None) the number of calls.

Example

cortex.secondary.call_number.call_number(call_direction="incoming", id="U1234567890", start=1607072400000, end=1609232400001, resolution=86400000)

Output:

{
'timestamp': 1607072400000,
'duration': 5616000000,
'resolution': 86400000,
'data': [
{'timestamp': 1607072400000, 'value': 0},
{'timestamp': 1607331600000, 'value': 6},
.
.
.
{'timestamp': 1609232400000, 'value': 3}
]
}