x/stackalytics
Code Issues Proposed changes

DOC: Update information on start_date & end_date

Browse Source 
Add information on start_date and end_date.  Explain the values that the
parameters take.

Change-Id: Id41a88c4e10f9e020c25a893b6986119e8711f76
This commit is contained in:
John L. Villalovos 2015-06-11 10:03:26 -07:00
parent 0fc633318d
commit f4ba337c35
1 changed files with 14 additions and 2 deletions

16
doc/source/userdoc/api_v1.0.rst

@ -67,8 +67,20 @@ All requests support common set of parameters that allow to filter resulting dat
............................
Data can be queried by time period:
* ``start_date`` - when the period starts
* ``end_date`` - when the period ends
========== ===========
Parameter Description
========== ===========
start_date When the period starts
end_date When the period ends
========== ===========
Both ``start_date`` and ``end_date`` take as their argument `Unix time
<http://en.wikipedia.org/wiki/Unix_time>`_
For example to specify ``'Thu Jan 1 00:00:00 UTC 2015'`` the value would be
``1420070400``
Note that if both release and time period are specified then the data is selected for the
intersection (thus the useful way is to specify release as ``all``).