{"_id":"5b6b4e99c523fd000322051b","project":"5668fab608f90021008e882f","version":{"_id":"5668fab608f90021008e8832","__v":19,"project":"5668fab608f90021008e882f","createdAt":"2015-12-10T04:08:22.769Z","releaseDate":"2015-12-10T04:08:22.769Z","categories":["5668fab708f90021008e8833","569740f124490c3700170a64","569742b58560a60d00e2c25d","569742bd0b09a41900b2446c","569742cd69393517000c82b3","569742f459a6692d003fad8f","569743020b09a41900b2446d","5697430b69393517000c82b5","56a17776470ae00d00c30642","56a2c48a831e2a0d0069b1ad","56b535757bccae0d00e9a1cd","56e1ff6aa49fdc0e005746b5","57e1c88115bf6522002a5e4e","57fa65275ba65a17008b988f","57fbeea34002550e004c032e","58474584889b6c2d00fb86e9","58475dcc64157f0f002f1907","587e7b5158666c2700965d4e","58a349fc30852819007ba083"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.18.0","version":"1.18"},"category":{"_id":"587e7b5158666c2700965d4e","project":"5668fab608f90021008e882f","__v":0,"version":"5668fab608f90021008e8832","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-17T20:15:13.711Z","from_sync":false,"order":3,"slug":"analytics-api","title":"Analytics API"},"user":"5668fa9755e4b32100935d41","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-08T20:12:09.341Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"settings":"587e7c7358666c2700965d5b","results":{"codes":[{"name":"","code":"{\n  \"message\" : \"Aggregation successful\",\n  \"impression_stats\": [...],\n  \"click_stats\": [...],\n  \"pageview_stats\": [...]\n}","language":"json","status":200},{"name":"","code":"{\n  \"message\" : \"Can't parse the date. Make sure that start date and end date follows ISO8601 (https://en.wikipedia.org/wiki/ISO_8601)\"\n}","language":"json","status":400},{"code":"{\n  \"message\" : \"ERROR: Aggregation failed. Analytics backend might be temporaily unavailable.\",\n  \"impression_stats\" = {},\n  \"click_stats\" = {},\n\t\"pageview_stats\" = {}\n}","language":"json","status":500},{"code":"{\n  \"message\" : \"Invalid API Key\"\n}","language":"json","status":401}]},"auth":"required","params":[{"_id":"587e8325db3b0319007af1e3","ref":"","in":"body","required":true,"desc":"Your LiftIgniter API Key","default":"","type":"string","name":"apiKey"},{"_id":"587e8325db3b0319007af1e2","ref":"","in":"body","required":true,"desc":"Start of time range for query in ISO8601 format","default":"","type":"string","name":"startDate"},{"_id":"587e8325db3b0319007af1e1","ref":"","in":"body","required":true,"desc":"End of time range for query in ISO8601 format","default":"","type":"string","name":"endDate"},{"_id":"587e838edb3b0319007af1e6","ref":"","in":"body","required":true,"desc":"IDs of the items you want to query stats for. This usually means the URLs of your page.","default":"","type":"array_string","name":"ids"},{"_id":"587e8325db3b0319007af1e0","ref":"","in":"body","required":false,"desc":"Values you want to slice (groupby) on","default":"['type','widgetName','hostName','country','state','city']","type":"array_string","name":"dimensions"},{"_id":"587e8325db3b0319007af1df","ref":"","in":"body","required":false,"desc":"Time granularity of the query. `all` to aggregate from start to end date, supports `hour`, `month`, and `year`.","default":"\"day\"","type":"string","name":"granularity"}],"url":"/items"},"isReference":false,"order":999,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Data lifetime\",\n  \"body\": \"LiftIgniter makes recent 4 weeks of data available for realtime aggregation. If you want the result to last then either schedule a query using /queries endpoint or independently store the results.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Query time\",\n  \"body\": \"If the data isn't cached on our server, then a query can take up to 10-20 seconds.\"\n}\n[/block]","excerpt":"","slug":"items","type":"endpoint","title":"/items"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

apiKey:
required
string
Your LiftIgniter API Key
startDate:
required
string
Start of time range for query in ISO8601 format
endDate:
required
string
End of time range for query in ISO8601 format
ids:
required
array of strings
IDs of the items you want to query stats for. This usually means the URLs of your page.
dimensions:
array of strings['type','widgetName','hostName','country','state','city']
Values you want to slice (groupby) on
granularity:
string"day"
Time granularity of the query. `all` to aggregate from start to end date, supports `hour`, `month`, and `year`.

Result Format


Documentation

[block:callout] { "type": "warning", "title": "Data lifetime", "body": "LiftIgniter makes recent 4 weeks of data available for realtime aggregation. If you want the result to last then either schedule a query using /queries endpoint or independently store the results." } [/block] [block:callout] { "type": "warning", "title": "Query time", "body": "If the data isn't cached on our server, then a query can take up to 10-20 seconds." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}