Using QuickSight to view analytics

Use Amazon QuickSight to view your API Connect Enterprise as a Service analytics data.

About this task

In API Connect Enterprise as a Service, analytics data is stored in shared S3 storage on Amazon Web Services. You can view your data using Amazon QuickSight.

Procedure

  1. Create a JSON manifest file.

    Create a .json file containing the following statement:

    { "fileLocations": [ { "URIPrefixes": [ "s3://apic-dev-analytics-filtered/<your_organisation_id>/" ] } ], "globalUploadSettings": { "format": "JSON" } }
    

    where <your_organisation_id> is your organization's ID.

  2. Log in to Amazon Web Services.

    If you don't have an AWS account, you can create it now.

    AWS login page
  3. In the search bar on the AWS page header, type "QuickSight" and then select it from the results.
    Search for QuickSight
  4. In the navigation list, select Datasets.
    Select "Datasets" in the navigation list
  5. On the Datasets page, click New dataset.
    Create a new dataset
  6. On the Create a dataset page, select S3 from the list of datasources.
    Select the S3 datasource
  7. On the New S3 datasource page, upload your manifest JSON file.
    1. For the Data source name field, provide a name that is meaningful to you.
    2. For the Upload a manifest file field, click Upload, locate your file, and upload it.
    3. Click Connect.
      Connect to the S3 datasource
  8. On the Finish dataset creation page, click Visualize to view your data.
    Dataset creation confirmation message

    Then wait for the "Import is complete" message to display.

    Import complete message
  9. On the Dataset analysis page, use the Visual types palette in the navigation list to view different types of charts.
    Dataset analysis page
  10. Share your visualization by clicking Share in the page header and selecting an option.

    Sharing the visualization stores a copy in QuickSight and makes it available to other members of your organization (based on the organization ID used in the manifest).

    • Share > Publish to dashboard
    • Share > Share analysis
  11. Export your visualization by clicking Export in the page header and selecting an option.

    Exporting the visualization prints a hardcopy or saves a PDF to your device.

    • Export > Print
    • Export > Download as PDF
  12. Save your visualization by clicking Save as in the page header and providing a name.

    Saving the visualization stores it in QuickSight for later use.