Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 1.71 KB

authors.md

File metadata and controls

64 lines (55 loc) · 1.71 KB

Get Authors Time Series

  • GET /sparkline/brands/authors provides SUM of AUTHORS grouped by day.

You MUST provide this parameters:

parameter format example description
startDate YYYY-MM-DD 2015-01-24 Starting range
endDate YYYY-MM-DD 2015-02-23 Ending range (including)

Optional parameters are:

parameter format example description
entities IDs separated by comma 1,2,4 Ids from /options/brands
opinions IDs separated by comma 1,2,3 Ids from Opinions table
groupingHours 1 or 24 24 Group results as 24hours period, ie: Days
previousPeriod Boolean false Should include Previously period

IMPORTANT: If you need to report a single brand's authors, you need to pass the entities parameter, otherwise you'll obtain the SUM of all authors participating on brands activities.

curl \
-H "username: $SMXUSER" \
-H "token: $TOKEN" \
"http://$INSTANCE.smxecho.com/ws/$INSTANCE/echo/sparkline/brands/authors?startDate=2015-02-01&endDate=2015-02-05"
{
  "current": {
    "total": 10,
    "values": [
      {
        "startDate": "2015-02-01 00:00",
        "endDate": "2015-02-01 23:59",
        "value": 3
      },
      {
        "startDate": "2015-02-02 00:00",
        "endDate": "2015-02-02 23:59",
        "value": 2
      },
      {
        "startDate": "2015-02-03 00:00",
        "endDate": "2015-02-03 23:59",
        "value": 0
      },
      {
        "startDate": "2015-02-04 00:00",
        "endDate": "2015-02-04 23:59",
        "value": 3
      },
      {
        "startDate": "2015-02-05 00:00",
        "endDate": "2015-02-05 23:59",
        "value": 2
      }
    ]
  }
}