{"__v":0,"_id":"562a5c846049f20d0032520b","category":{"__v":7,"_id":"54fdad6e660db63700c23b82","pages":["55fbef82af72eb0d0007df93","55fbf623e013770d008fcba8","5617bd3a26e3db230054fba4","5617c4a6f8c9632100ac74f5","561ed6fd0a04340d00d8a0b0","562156adf4e0352100cbf268","562a5c846049f20d0032520b"],"project":"54d0fd1d095c470d00d1646d","version":"54d0fd1e095c470d00d16470","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-09T14:25:50.133Z","from_sync":false,"order":2,"slug":"api-reference","title":"API Reference"},"editedParams":true,"editedParams2":true,"project":"54d0fd1d095c470d00d1646d","user":"54d0fc4b7493b40d00400243","version":{"__v":20,"_id":"54d0fd1e095c470d00d16470","project":"54d0fd1d095c470d00d1646d","createdAt":"2015-02-03T16:53:50.090Z","releaseDate":"2015-02-03T16:53:50.090Z","categories":["54d0fd1e095c470d00d16471","54d8b5e68934140d00496544","54db6361c6a4d40d0034b8f7","54db638208ea010d00ab1fdd","54db639008ea010d00ab1fde","54db6547c6a4d40d0034b8fd","54db83482092743700ea6ee1","54db84afc6a4d40d0034b93c","54db8805c6a4d40d0034b93f","54db8de9c6a4d40d0034b961","54db931ac6a4d40d0034b96d","54e49219e4365521006fd9ee","54e74fcc652d7c1900cbe737","54e74ffd3c1e111700d05762","54e77e0a523b1b2f00e6f313","54e784affdabe62500fcddcf","54e784fa523b1b2f00e6f319","54e785de8ae8911900cd42c5","54fdad6e660db63700c23b82","54fdff31f7b1202100a25e06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-23T16:12:52.884Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"CURL","code":"curl -k -X GET -H \"Cache-Control: no-cache\" 'https://api.gogeo.io/1.0/aggregations/MY_DATABASE/MY_COLLECTION/date_histogram?mapkey=MY_MAP_KEY&field=DATE_FIELD&interval=month'","language":"shell"}]},"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"timestamp\": 1328140800000,\n    \"date_string\": \"2013-02-02\",\n    \"count\": 29\n  },\n  {\n    \"timestamp\": 1330646400000,\n    \"date_string\": \"2013-03-02\",\n    \"count\": 20\n  }\n]","name":""}]},"settings":"","auth":"never","params":[{"_id":"562a5777007ab40d007cb438","ref":"","in":"path","required":true,"desc":"Database name","default":"","type":"string","name":"database_name"},{"_id":"562a5777007ab40d007cb437","ref":"","in":"path","required":true,"desc":"Collection name","default":"","type":"string","name":"collection_name"},{"_id":"562a5777007ab40d007cb436","ref":"","in":"query","required":true,"desc":"You mapkey","default":"","type":"string","name":"mapkey"},{"_id":"561ed6fd0a04340d00d8a0b5","ref":"","in":"query","required":true,"desc":"Numeric field subject to aggregation","default":"","type":"string","name":"field"},{"_id":"562156adf4e0352100cbf269","ref":"","in":"query","required":true,"desc":"Date interval (year, quarter, month, week, day, hour, minute, second, 6h, 1.5d). [learn more](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html)","default":"","type":"string","name":"interval"},{"_id":"561ed6fd0a04340d00d8a0b4","ref":"","in":"query","required":false,"desc":"Date output format (Ex.: yyyy-MM-dd, dd/MM/yyyy)","default":"","type":"string","name":"date_format"},{"_id":"561ed6fd0a04340d00d8a0b3","ref":"","in":"query","required":false,"desc":"Optional elastic search query to filter data","default":"","type":"string","name":"q"},{"_id":"561ed6fd0a04340d00d8a0b2","ref":"","in":"query","required":false,"desc":"Optional geometry (GeoJSON) for spatial restriction","default":"","type":"string","name":"geom"}],"url":"/aggregations/:database_name/:collection_name/date_histogram"},"isReference":false,"order":45,"body":"","excerpt":"Generates a histogram for a date and date/time field and a given date interval. You can optionally apply filters (spatial filter included) and change the summarization's field and operation.","slug":"date-histogram-aggregation","type":"get","title":"Date Histogram Aggregation"}

getDate Histogram Aggregation

Generates a histogram for a date and date/time field and a given date interval. You can optionally apply filters (spatial filter included) and change the summarization's field and operation.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

database_name:
required
string
Database name
collection_name:
required
string
Collection name

Query Params

mapkey:
required
string
You mapkey
field:
required
string
Numeric field subject to aggregation
interval:
required
string
Date interval (year, quarter, month, week, day, hour, minute, second, 6h, 1.5d). [learn more](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html)
date_format:
string
Date output format (Ex.: yyyy-MM-dd, dd/MM/yyyy)
q:
string
Optional elastic search query to filter data
geom:
string
Optional geometry (GeoJSON) for spatial restriction

Examples


Result Format


User Information

Try It Out

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