Fetch sessions

post https://{account}.piwik.pro/api/analytics/v1/sessions/

API that allows fetching raw sessions from the database (event-level data
is not available in this API). Please note that each request must be
authenticated.

Compression

When requesting large amount of data, make sure to include
an Accept-Encoding: gzip header to enable
compression.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

website_id

uuid

required

ID of a website or a meta site.

columns

array of objects

required

Definitions of additional columns that should be returned (timestamp and
identifiers will be returned by default).

columns*

date_from

string

Cannot be used with relative_date field at the same time. Mandatory if relative_date is not used.

date_to

string

Cannot be used with relative_date field at the same time. Mandatory if relative_date is not used.

relative_date

string

Use relative date in query. Cannot be used with absolute date fields at
the same time. X in last_X_days must be in range 1 <= X <= 365.
Note that last_X_days does not include data from today.
Mandatory if absolute date fields are not used.

filters

object

Dimension filters for the query. The top-level object must specify
AND/OR clause, but any nested objects may either specify another AND/OR
clause or a single filter.

offset

integer

≥ 0

Defaults to 0

Number of rows to skip before beginning to return rows.

limit

integer

1 to 100000

Defaults to 100

Number of rows to return.

format

string

Defaults to json

Data format of a successful response (error responses are always in json).

column_format

string

Defaults to id

Format of the columns header (in CSV responses) and metadata labels
(in JSON responses). By default uses identifiers (id option), set to
name to use human-readable names.

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://example.piwik.pro/api/analytics/v1/sessions/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "filters": {
8
    "operator": "and"
9
  },
10
  "offset": 0,
11
  "limit": 100,
12
  "format": "json",
13
  "column_format": "id"
14
}
15
'


xxxxxxxxxx
24
 
1
{
2
  "data": [
3
    [
4
      "2132601",
5
      "2ecf33167d400648",
6
      "2018-12-03T00:21:03",
7
      "375x667",
8
      [
9
        1,
10
        "Smartphone"
11
      ]
12
    ]
13
  ],
14
  "meta": {
15
    "columns": [
16
      "session_id",
17
      "visitor_id",
18
      "timestamp",
19
      "resolution",
20
      "device_type"
21
    ],
22
    "count": 1999
23
  }
24
}

Fetch sessions

Compression

Get the full experience

Analytics

200OK

400Bad Request

401Unauthorized

403Forbidden

Get the full experience

Analytics