Returns the file status of a single file within a Omnichannel File Definition.


Resource URL

GET https://api.tealiumiq.com/v1/omnichannel/accounts/{account}/profiles/{profile}/files/{file name}?utk={utk token}

 

Path Parameters Description
{account} Name of the AudienceStream account
{profile} Name of the AudienceStream profile where the File Definition exists
{file name} Name of the file you are requesting the status for. Be sure to append ".csv" after the name.
NOTE: File name should not exceed 150 chars
Query Parameters Description
utk_token CSRF security token

Request Header

Header Field Name Description Example value
Content-type MIME type of the body of the GET request application/json
JSESSION cookie Cookie for sending jsession ID, i.e. the unique session identifier JSESSIONID=415072043799098022

Example Request

GET https://api.tealiumiq.com/v1/omnichannel/accounts/acme/profiles/main/files/sales-transaction_2016feb4v50.csv?utk=41HX720DW7990980

Example Response

Returns a JSON object (key-value pairs) containing the file name, size, line count (i.e. number of rows) and number of lines processed, including any processing errors. Below is a sample file status. For a complete list of keys, refer to the Overview section. 

{
    "_id": {
      "$oid": "5702ea6db993f8f8cbea334c"
    },
    "account": "acme",
    "created_at": {
      "$date": "2016-04-04T22:27:56.993Z"
    },
    "file": {
      "name": "sales-transaction_2016feb4v50.csv",
      "size": 2744,
      "checksum": "44b12d35ea9fffdeeb69f98b03004f22",
      "source": {
        "type": "s3",
        "host": "johndoe:"
      },
      "line_count": 35
    },
    "node_id": "bulk_downloader_i-cd504b49",
    "profile": "main",
    "status": [
      {
        "state": "DOWNLOADING",
        "timestamp": {
          "$date": "2016-04-04T22:27:57.285Z"
        }
      },
      {
        "state": "DOWNLOADED",
        "timestamp": {
          "$date": "2016-04-04T22:27:57.722Z"
        }
      },
      {
        "state": "PROCESSING",
        "timestamp": {
          "$date": "2016-04-04T22:27:57.780Z"
        },
        "lines_skipped": 34
      },
      {
        "state": "PROCESSED",
        "timestamp": {
          "$date": "2016-04-04T22:27:58.797Z"
        }
      }
    ]
  }

Error Messages

Error Type Description
404 Not Found Supplied file name not found
400 Bad request File name exceeds 150 chars