{"__v":2,"_id":"54db89ddc6a4d40d0034b953","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":"54db525474dfff3700f161e9","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-02-11T16:57:01.884Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"api_key\": \"18a16d62-896a-4628-bc33-ff49c3e889a8\",\n    \"collection_id\": \"54dcac09636f6e6fe5000000\",\n    \"created_at\": \"2015-02-12T11:59:07.929-02:00\",\n    \"database_id\": \"54427a18636f6e73fb000000\",\n    \"database_name\": \"db1\",\n    \"done\": 40491,\n    \"elasticsearch_index\": [],\n    \"estimated_items\": 1000,\n    \"extension\": \"bz2\",\n    \"extract?\": true,\n    \"has_geom_column\": true,\n    \"id\": \"54dcb1ab636f6e0774000000\",\n    \"items\": 1000,\n    \"message\": null,\n    \"metadata\": {\n        \"field_delimiter\": \";\",\n        \"geom\": {\n            \"type\": \"wkt_point\",\n            \"fields\": [\n                \"the_geom\"\n            ]\n        },\n        \"mapping\": [\n            [\n                \"name\",\n                \"string\"\n            ],\n            [\n                \"city\",\n                \"string\"\n            ],\n            [\n                \"country\",\n                \"string\"\n            ],\n            [\n                \"website\",\n                \"string\"\n            ],\n            [\n                \"address\",\n                \"string\"\n            ],\n            [\n                \"postcode\",\n                \"string\"\n            ],\n            [\n                \"owner\",\n                \"string\"\n            ],\n            [\n                \"category\",\n                \"string\"\n            ],\n            [\n                \"type\",\n                \"string\"\n            ],\n            [\n                \"subcategory\",\n                \"string\"\n            ],\n            [\n                \"tags\",\n                \"string\"\n            ],\n            [\n                \"the_geom\",\n                \"wkt_point\"\n            ]\n        ],\n        \"header\": true\n    },\n    \"operation\": \"insert\",\n    \"progress\": 100,\n    \"size\": 40491,\n    \"stage\": \"finished\",\n    \"total\": 1000,\n    \"updated_at\": \"2015-02-12T11:59:33.361-02:00\",\n    \"url\": \"https://www.dropbox.com/s/47i6toeuj6wwvv7/simpleGeoUS_1k.csv.tar.bz2?dl=1\",\n    \"user_id\": \"5433e1fe636f6e7704000000\",\n    \"username\": \"gogeo\",\n    \"collection_name\": \"simplegeo_test02\"\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"54db9fa4b813d12d007dd001","ref":"","in":"path","required":true,"desc":"Id of the import operation.","default":"","type":"string","name":"import_id"}],"url":"/imports/:import_id"},"isReference":false,"order":23,"body":"Retrieve the status of the import. When you performs a request to import a file, the response json informs the **id** of the import that is used to retrieve the status of the import. The response will be a JSON informing the stage of the process.\n\n### Sample Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user <API-KEY>:\\\"\\\" -k \\\"http://api.gogeo.io/1.0/imports/53b3019d726f623dab000000\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_key\\\": \\\"18a16d62-896a-4628-bc33-ff49c3e889a8\\\",\\n    \\\"collection_id\\\": \\\"54dcac09636f6e6fe5000000\\\",\\n    \\\"created_at\\\": \\\"2015-02-12T11:59:07.929-02:00\\\",\\n    \\\"database_id\\\": \\\"54427a18636f6e73fb000000\\\",\\n    \\\"database_name\\\": \\\"db1\\\",\\n    \\\"done\\\": 40491,\\n    \\\"elasticsearch_index\\\": [],\\n    \\\"estimated_items\\\": 1000,\\n    \\\"extension\\\": \\\"bz2\\\",\\n    \\\"extract?\\\": true,\\n    \\\"has_geom_column\\\": true,\\n    \\\"id\\\": \\\"54dcb1ab636f6e0774000000\\\",\\n    \\\"items\\\": 1000,\\n    \\\"message\\\": null,\\n    \\\"metadata\\\": {\\n        \\\"field_delimiter\\\": \\\";\\\",\\n        \\\"geom\\\": {\\n            \\\"type\\\": \\\"wkt_point\\\",\\n            \\\"fields\\\": [\\n                \\\"the_geom\\\"\\n            ]\\n        },\\n        \\\"mapping\\\": [\\n            [\\n                \\\"name\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"city\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"country\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"website\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"address\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"postcode\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"owner\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"category\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"type\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"subcategory\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"tags\\\",\\n                \\\"string\\\"\\n            ],\\n            [\\n                \\\"the_geom\\\",\\n                \\\"wkt_point\\\"\\n            ]\\n        ],\\n        \\\"header\\\": true\\n    },\\n    \\\"operation\\\": \\\"insert\\\",\\n    \\\"progress\\\": 100,\\n    \\\"size\\\": 40491,\\n    \\\"stage\\\": \\\"finished\\\",\\n    \\\"total\\\": 1000,\\n    \\\"updated_at\\\": \\\"2015-02-12T11:59:33.361-02:00\\\",\\n    \\\"url\\\": \\\"https://www.dropbox.com/s/47i6toeuj6wwvv7/simpleGeoUS_1k.csv.tar.bz2?dl=1\\\",\\n    \\\"user_id\\\": \\\"5433e1fe636f6e7704000000\\\",\\n    \\\"username\\\": \\\"gogeo\\\",\\n    \\\"collection_name\\\": \\\"simplegeo_test02\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div class=\\\"panel panel-info teste\\\" >\\n  <div class=\\\"panel-body\\\">\\n    This endpoint requires an API key. See <a href=\\\"basic-auth\\\">Basic Authentication</a> for more information about the goGeo authentication system.\\n\\t\\t<br><br>\\n\\t  If you don't have an access key yet, <a href=\\\"https://console.gogeo.io/signup\\\">sign up</a> and take yours!\\n  </div>\\n</div>\\n\"\n}\n[/block]\n---\n[block:html]\n{\n  \"html\": \"<div class='div-middle'> \\n  <a href='#'>\\n    Top page &spades; </div>\\n  </a>\\n</div>\\n\\n<div class='div-back'> \\n  <a href='/v1.0/docs/list-all-imported-files'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<div class='div-forward'> \\n  <a href='/v1.0/docs/delete-a-data-import'>\\n    Next &raquo; </div>\\n  </a>\\n</div>\\n\\n<style>\\n\\t.div-back {\\n  \\tpadding-left: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n  \\n  .div-middle {\\n  \\ttext-align: center;\\n\\t\\tmargin-top: -15px;\\n  }\\n  \\n  .div-forward {\\n  \\tfloat: right;\\n    padding-right: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n</style>\"\n}\n[/block]","excerpt":"Retrieve the status of the import.","slug":"get-a-import-data","type":"get","title":"Retrieve import status"}

getRetrieve import status

Retrieve the status of the import.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

import_id:
required
string
Id of the import operation.

Result Format


Documentation

Retrieve the status of the import. When you performs a request to import a file, the response json informs the **id** of the import that is used to retrieve the status of the import. The response will be a JSON informing the stage of the process. ### Sample Request [block:code] { "codes": [ { "code": "curl --user <API-KEY>:\"\" -k \"http://api.gogeo.io/1.0/imports/53b3019d726f623dab000000\"", "language": "curl" } ] } [/block] ### Sample Response [block:code] { "codes": [ { "code": "{\n \"api_key\": \"18a16d62-896a-4628-bc33-ff49c3e889a8\",\n \"collection_id\": \"54dcac09636f6e6fe5000000\",\n \"created_at\": \"2015-02-12T11:59:07.929-02:00\",\n \"database_id\": \"54427a18636f6e73fb000000\",\n \"database_name\": \"db1\",\n \"done\": 40491,\n \"elasticsearch_index\": [],\n \"estimated_items\": 1000,\n \"extension\": \"bz2\",\n \"extract?\": true,\n \"has_geom_column\": true,\n \"id\": \"54dcb1ab636f6e0774000000\",\n \"items\": 1000,\n \"message\": null,\n \"metadata\": {\n \"field_delimiter\": \";\",\n \"geom\": {\n \"type\": \"wkt_point\",\n \"fields\": [\n \"the_geom\"\n ]\n },\n \"mapping\": [\n [\n \"name\",\n \"string\"\n ],\n [\n \"city\",\n \"string\"\n ],\n [\n \"country\",\n \"string\"\n ],\n [\n \"website\",\n \"string\"\n ],\n [\n \"address\",\n \"string\"\n ],\n [\n \"postcode\",\n \"string\"\n ],\n [\n \"owner\",\n \"string\"\n ],\n [\n \"category\",\n \"string\"\n ],\n [\n \"type\",\n \"string\"\n ],\n [\n \"subcategory\",\n \"string\"\n ],\n [\n \"tags\",\n \"string\"\n ],\n [\n \"the_geom\",\n \"wkt_point\"\n ]\n ],\n \"header\": true\n },\n \"operation\": \"insert\",\n \"progress\": 100,\n \"size\": 40491,\n \"stage\": \"finished\",\n \"total\": 1000,\n \"updated_at\": \"2015-02-12T11:59:33.361-02:00\",\n \"url\": \"https://www.dropbox.com/s/47i6toeuj6wwvv7/simpleGeoUS_1k.csv.tar.bz2?dl=1\",\n \"user_id\": \"5433e1fe636f6e7704000000\",\n \"username\": \"gogeo\",\n \"collection_name\": \"simplegeo_test02\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<div class=\"panel panel-info teste\" >\n <div class=\"panel-body\">\n This endpoint requires an API key. See <a href=\"basic-auth\">Basic Authentication</a> for more information about the goGeo authentication system.\n\t\t<br><br>\n\t If you don't have an access key yet, <a href=\"https://console.gogeo.io/signup\">sign up</a> and take yours!\n </div>\n</div>\n" } [/block] --- [block:html] { "html": "<div class='div-middle'> \n <a href='#'>\n Top page &spades; </div>\n </a>\n</div>\n\n<div class='div-back'> \n <a href='/v1.0/docs/list-all-imported-files'>\n &laquo; Back \n </a>\n</div>\n\n<div class='div-forward'> \n <a href='/v1.0/docs/delete-a-data-import'>\n Next &raquo; </div>\n </a>\n</div>\n\n<style>\n\t.div-back {\n \tpadding-left: 15px;\n\t\tmargin-top: -20px;\n }\n \n .div-middle {\n \ttext-align: center;\n\t\tmargin-top: -15px;\n }\n \n .div-forward {\n \tfloat: right;\n padding-right: 15px;\n\t\tmargin-top: -20px;\n }\n</style>" } [/block]

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 }}