Get Import File Data

Get the progress of an upload.

It requires the run-import permission.
URL
Requires Auth
HTTP Method
/api/v1/getImportFileData
yes
GET
Headers
Argument
Example
Required
Description
X-User-Id
myuser-name
Required
The authenticated  user ID.
X-Auth-Token
myauth-token
Required
Auth token.
Example Call
Curl
Node.js
Python
PHP
Java
curl -L -X GET 'http://localhost:3000/api/v1/getImportFileData' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'http://localhost:3000/api/v1/getImportFileData',
  'headers': {
    'X-User-Id': 'd26x6zSkaPSe5gCyy',
    'X-Auth-Token': 'Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
​
url = "http://localhost:3000/api/v1/getImportFileData"
​
payload={}
headers = {
  'X-User-Id': 'd26x6zSkaPSe5gCyy',
  'X-Auth-Token': 'Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'
}
​
response = requests.request("GET", url, headers=headers, data=payload)
​
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('http://localhost:3000/api/v1/getImportFileData');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'X-User-Id' => 'd26x6zSkaPSe5gCyy',
  'X-Auth-Token' => 'Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/getImportFileData")
  .header("X-User-Id", "d26x6zSkaPSe5gCyy")
  .header("X-Auth-Token", "Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92")
  .asString();
Example Result
Success
{
    "users": [],
    "channels": [],
    "message_count": 0,
    "success": true
}
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
No Permission: This occurs when the authenticated user doesn't have the  run-import permission.
 Authorization
No Permission
{
    "success": false,
    "error": "unauthorized"
}
{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Change Log
Version
Description
3.0.0
Added

URL	Requires Auth	HTTP Method
`/api/v1/getImportFileData`	`yes`	`GET`

Argument	Example	Required	Description
`X-User-Id`	`myuser-name`	Required	The authenticated user ID.
`X-Auth-Token`	`myauth-token`	Required	Auth token.

Version	Description
`3.0.0`	Added

Last modified 4mo ago