408.600.2737info@convermax.com
Last updated: July 20, 2015

API

  • Analytics

    Analytics for storing specific data about user actions on site.

    • Track

      Creates an entry in the log for a specific user action.

  • Search

    Search and accompanying methods.

    • Search

      Returns search results.

    • Autocomplete

      Returns prompts (similar meanings) for the entered word.

    • Item

      Returns a given item from index.

     
  • Service

    Performance check.

    • Checks service performance. In case of an error (e.g. failed indexing) returns status code 500. 

  • Scheme

    Methods of working with schemes.

    • Scheme create

      Creates an empty scheme with a given name. Returns generated hash of a new scheme.

    • Scheme delete

      Deletes an existing scheme and all data, without a chance to restore.

    • Scheme create fields

      Adds fields to the scheme from transferred template.

    • Scheme check updates

      Updates scheme data, e.g. if the scheme has been altered out of services.

     
  • BatchUpdate

    Batch addition, update and deletion of items in index from a remote data source.

    • Start

      Starts reindexing. If during the operation Abort command is initiated, index contents will remain unchanged, as before initiating Start method (works together with Add, Update, Delete and End).

    • Add

      Saves transferred items to index (works together with Start and End).

    • Update

      Updates items in index according to key fields set in admin panel (works together with Start and End).

    • Delete

      Deletes items from index according to key fields set in admin panel (works together with Start and End).

    • End

      Finishes reindexing (works together with Start, Add, Update, Delete).

    • Abort

      Cancels reindexing, index contents will remain unchanged, as before initiating Start method (can be initiated after Start, but before End).

  • Update

    Stream addition, update and deletion of items in index from a remote data source.

    • Add

      Adds items to index (CSV-files can be uploaded).

    • Update

      Updates items in index.

    • Delete by mask

      Deletes items from index according to keys.

    • Abort

      Cancels reindexing, index contents will remain unchanged, as before reinitiating.

  • Indexing

    Information on indexing status.

    • Status

      Returns indexing status. Can be initiated during indexing.