Integrations
      Back to home
      1. FFAIR Help Desk
      2. Organiser
      3. Integrations

      JSON Feed for Custom Reports

      The JSON Feed for Custom Reports feature is now available as one of our in-app paid upgrades, allowing you to turn custom reports into live API feeds, enabling real-time data integration with external sites and applications.

      Overview

      With the JSON Feed for Custom Reports, you can:

      • Stream Real-Time Data: Generate a live API feed that provides dynamic report data through a unique feed URL.

      • Customise Your Data: Choose to include all sheets in the report or just the current sheet. Applied filters are reflected in the JSON output for precise data control.

      • Enable Automatic Updates: The data feed refreshes every 30 minutes, ensuring your external integrations stay up-to-date.

      This feature is available for a one-time fee of £250 per show.

      Key Features

      1. Live Data Access

      • Create a unique feed URL for each custom report.

      • Use the feed to deliver data directly to external systems or applications.

      2. Customisable Data Options

      • Include All Sheets: Combine all report sheets into a single JSON feed.

      • Single Sheet Feeds: Limit the feed to data from the current sheet.

      • Filters Applied: Any filters set in the report are reflected in the JSON feed.

      3. Automatic Updates

      • The feed refreshes automatically every 30 minutes to ensure data accuracy.

      • Updates in the report are reflected in the feed JSON.

      4. Secure Access

      • Disabled feeds return a 403 error.

      • Feed URLs are secure and include a unique key.

      • Regenerate feed keys as needed.

      How to Enable and Use the JSON Feed

      Step 1: Unlock the Feature

      1. Go to the Custom Reports section of your dashboard.

      2. Click the Feed button. If the feature is not yet activated, a payment pop-up will appear.

      3. Complete the payment (£250) via the embedded Stripe payment page.

      4. Once payment is confirmed, the lock icon disappears, and the feed functionality is unlocked for the show.

      Step 2: Enable the Feed

      1. Click the Feed button on your chosen report.

      2. Toggle the Enable Feed option to activate the feed.

      3. A unique Feed URL is generated. Use the Copy to Clipboard button to copy the URL for integration.

      4. (Optional) Use the Include All Sheets checkbox to include all report sheets in the JSON feed.

      Step 3: Manage the Feed

      • Use the Show URL button to view the feed URL.

      • Regenerate the feed key if necessary to ensure security.

      • Any filters applied in the custom report will be reflected in the JSON feed data.

      • If the custom report is removed, the feed is automatically disabled.

      JSON Feed Format

      The feed outputs data in a JSON format structured as follows:

      {
        "SheetName1": [
          {
            "key": "Example Key",
            "value": "Example Value"
          }
        ],
        "SheetName2": [
          {
            "key": "Another Key",
            "value": "Another Value"
          }
        ]
      }

      Troubleshooting

      • 403 Error: Ensure the feed is enabled and that you have access to the correct URL.

      • Feed Not Updating: Confirm that the report has been saved after making changes. The feed refreshes every 30 minutes.

      • Missing Data: Verify that the correct sheets and filters are selected in the report.

      FAQs

      Can I use the feed for multiple reports?

      Yes, each custom report has its own independent feed, which can be enabled or disabled as needed.

      What happens if I delete the custom report?

      Deleting the report will automatically disable the associated feed.

      How often does the feed refresh?

      The feed updates every 30 minutes to reflect any changes made to the report.