Download outgoing feed created packages#

Manually download created packages#

  1. In the in the left navigation bar, go to Data configuration Data configuration icon > Outgoing feeds.

  2. In the Outgoing feeds view, click anywhere in the row corresponding to the outgoing feed whose content you want to view or retrieve.

  3. In the selected outgoing feed detail pane, click the Created packages tab.

  4. In the Created packages tab, under the Download column header, click the name of a package to download it, and to save it to a target location.

Programmatically download created packages#

Note

The URLs pointing to specific outgoing feed packages in the Created packages tab expose API endpoints for programmatic content retrieval.

It is not possible to download the packages manually by clicking the URLs in the GUI.

The Created packages tab on an outgoing feed detail pane can include one or more URLs to enable programmatic feed content retrieval by sending API requests to the URL endpoints.

To access the URLs enabling outgoing feed content download:

  1. In the top navigation bar click Data configuration > Outgoing feeds.

  2. In the Outgoing feeds view, click anywhere in the row corresponding to the outgoing feed whose content you want to view or retrieve.

    The detail pane of the selected object is displayed.

  3. In the selected outgoing feed detail pane, click the Created packages tab.

  4. In the Created packages tab, above the table listing the available packages for download, one or more URLs are displayed, along with short descriptive captions.

    These URLs expose endpoints you can make API requests to, to retrieve specific outgoing feed packages.

Programmatically download created packages from HTTP download outgoing feeds#

You can download packages from HTTP download outgoing feeds by making authenticated GET requests to the endpoints provided in the Created packages tab.

To make requests to the HTTP download outgoing feed endpoint:

  1. Create an API token: Create an API token.

  2. Make the following reqeust with cURL:

    # Export the token as a variable, where <api_token> is the value obtained from the cURL command above
export token=<api_token>

# Make an API request where:
# - You pass your authentication Bearer token
# - Request a list of all packages from the latest outgoing feed task run
curl -X GET \
    -v \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${token}" \
    --url https://${platform_host}/private/outgoing-feed-download/${feed_id}/runs/latest

Each outgoing feed using the HTTP download transport type creates an endpoint on your EclecticIQ Intelligence Center instance when it runs.

  • When authentication is required by the feed, creates: https://tip.example.com/private/outgoing-feed-download/<feed-id>/

  • For public feeds, creates: https://tip.example.com/private/open-outgoing-feed-download/<feed-id>/

Each HTTP download outgoing feed endpoint has the following resources:

GET /<feed-id>/#

Lists all created packages for a given feed ID.

Example response:

{
  "data": {
    "content_blocks": [
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/11",
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/12",
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/13"
    ],
    "id": 9,
    "name": "public feed"
  }
}

GET /<feed-id>/runs/<id>#

Each time an outgoing feed runs and successfully produces packages, its results can be found at this resource.

  • /<feed-id>/runs/<id>: Lists metadata and content_blocks for a given run ID.

  • /<feed-id>/runs/latest: Lists metadata and content_blocks for the latest run.

Example response:

{
  "data": {
    "content_blocks": [
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/11",
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/12",
      "/private/open-outgoing-feed-download/9/runs/f4479af7-7ae0-4915-a957-3a36fef37a82/content-blocks/13"
    ],
    "id": 9,
    "name": "public feed"
  }
}

GET /<feed-id>/runs/<id>/content-blocks/<content-block-ID>#

Get contents of this content block. This is a package in the format set by the feed’s content type.

E.g. If the content type is:

  • EclecticIQ Entities CSV, the response body contains CSV content.

  • EclecticIQ JSON, the response body contains JSON content.