The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Why use this Service?
  • How it Works
  • How to Provide your Images
  • Supplementing or Overriding Existing Images
  • Default Images
  1. HINTS & TIPS
  2. Get the Best Out of Search

Customer Specific Images

PreviousYour Search Results and HighFrequencySessionsNextYour RPDE Feed & the imin Platform [BETA]

Last updated 3 years ago

Why use this Service?

We consume open data from a variety of sources, from big leisure operators to small, local instructors and everything in between. Open data from some sources is higher quality than others, but at imin, we do our best to ensure that you are getting the highest quality data across the board.

The Customer Specific Images service allows us to improve the quality of data we provide to you across all providers by adding images of your choosing. This service means that you can choose bespoke images that are suited to your demographic, therefore, ensuring you are providing a high quality UX for your end users.

How it Works

The CSI service works by returning a bespoke image based on an activity type.

For example, on the simplest level*, if you provide an image of people playing badminton and the end user makes a search for "Badminton", your image will be returned.

*This functionality is subject to whether you choose to .

With this in mind, it is important that your familiarise yourself with the and select the activities for which you want bespoke images to appear.

How to Provide your Images

Please ensure that the following provisions are complied with:

  • Images must not exceed 1,200px x 800px (via our Search API, we provide the original image, as well as two thumbnail images).

  • Images must be saved within one large folder (rather than in sub-folders), which must be emailed to us as a zip file.

  • Images must correspond to an activity in the .

  • The image file names must correspond with the notations in the Activity List (please refer to the for this), i.e. file names must:

    • Be lowercase (e.g. abscore); and

    • Have an underscore where an activity type includes a space(s) (e.g. aqua_fit_shallow_water).

  • Images must be provided in JPEG format and saved with ".jpg" at the end (e.g. street_dance.jpg).

  • If you are providing a default image (see ), please ensure the file is named default.jpg.

Please ensure all images comply with these requirements and email them to us in a zip file.

Supplementing or Overriding Existing Images

The CSI service can do one of two things:

  1. Supplement existing images for all items in the data that do not already have an image (images already present in the data will be provided by the open data provider at source); or

  2. Override all existing images already included in the data.

Example of how "supplement" works:

  • If an open data provider includes an image for a football session, this image, and not your football image, will appear when the end user searches for football.

  • If an open data provider does not include an image for a yoga class, your yoga image will appear when the end user searches for yoga.

Example of how "override" works:

  • If an open data provider includes an image for a tennis session, your tennis image, and not the providers image, will appear when the end user searches for tennis.

Please let us know if you want to go for option 1 (supplement images) or option 2 (override images).

Default Images

Given the large number of activities in the OpenActive Activity List, it is likely that you will not want to provide an image for each activity type. If this is the case, you can provide us with a default image that will appear for activities for which you have not provided us an image. If you opt for this feature, we recommend that the default image is as generic as possible.

Please let us know if you will be providing a default image and, if so, ensure it is named default.jpg.

supplement or override existing images
OpenActive Activity List
OpenActive Activity List
jsonld List
below