Test rest viewer

Instant Search Proxy

Optimaliseer indexbeheer met ons ProxyIndex model. Beheer moeiteloos index-aliassen, sjablonen en filters voor verbeterde zoek- en filtermogelijkheden. Verken deze documentatie om de efficiëntie van de API te maximaliseren.

Properties

aliasstring

The index alias

templateobject

results_per_pageinteger

The number of results per page for this index

filtersarray[ProxyIndexFilter]

Instant Search Proxy

  {
  "alias": "products",
  "template": {
    "name": null,
    "mapping": [
      {}
    ]
  },
  "results_per_page": 10,
  "filters": [
    {
      "key": "category",
      "options_count": 10,
      "max_options_count": 10
    }
  ]
}

GET

/api/instant/proxies

List instant Search proxies

De listInstantProxies operatie is een GET API-endpoint dat een lijst van zoekmachines ophaalt voor een specifieke huurder. Het ondersteunt optionele paginering, geeft gedetailleerde proxy-objecten terug bij succes, en levert uitgebreide foutinformatie bij falen. Deze snelheid-beperkte operatie vereist authenticatie met een bearer token en is ontworpen voor openbare blootstelling.

Query parameters

page[size]integer

page[after]string

Response body

keystring

The unique key of the proxy

filtersobject

is_autocompleteboolean

Whether or not this search engine is used as an autocomplete search

click_trackingobject

indexesarray[ProxyIndex]

created_atinteger

Format

int64

updated_atinteger

Format

int64

curl https://afosto.app/api/instant/proxies 
  -X GET 
  -H "Authorization: Bearer {token}"

{
  "data": [
    {
      "key": "afosto",
      "filters": {
        "show_for": "products",
        "sorting": [
          "category",
          "price"
        ],
        "options_count": 5,
        "max_options_count": 25
      },
      "is_autocomplete": null,
      "click_tracking": {
        "is_enabled": null
      },
      "indexes": [
        {
          "alias": "products",
          "template": {
            "name": null,
            "mapping": [
              {}
            ]
          },
          "results_per_page": 10,
          "filters": [
            {
              "key": "category",
              "options_count": 10,
              "max_options_count": 10
            }
          ]
        }
      ],
      "created_at": null,
      "updated_at": null
    }
  ],
  "page": {
    "first": "https://afosto.app/api/instant/proxies",
    "next": "https://afosto.app/api/instant/proxies?page[after]=Nne9H5q3ZuddquhTrkGCImjN5",
    "after": "Nne9H5q3ZuddquhTrkGCImjN5",
    "previous": "https://afosto.app/api/instant/proxies?page[after]=Nne9H5q3ZuddquhTrkGCImjN5",
    "before": "Nne9H5q3ZuddquhTrkGCImjN5"
  }
}

POST

/api/instant/proxies

Create proxy

Request body

keystringRequired

The unique key of the proxy

filtersobject

is_autocompleteboolean

Whether or not this search engine is used as an autocomplete search

click_trackingobject

indexesarray[ProxyIndex]

Response body

keystring

The unique key of the proxy

filtersobject

is_autocompleteboolean

Whether or not this search engine is used as an autocomplete search

click_trackingobject

indexesarray[ProxyIndex]

created_atinteger

Format

int64

updated_atinteger

Format

int64

curl https://afosto.app/api/instant/proxies 
  -X POST 
  -d '{
  "data": {
    "key": "afosto",
    "filters": {
      "show_for": "products",
      "sorting": [
        "category",
        "price"
      ],
      "options_count": 5,
      "max_options_count": 25
    },
    "is_autocomplete": null,
    "click_tracking": {
      "is_enabled": null
    },
    "indexes": [
      {
        "alias": "products",
        "template": {
          "name": null,
          "mapping": [
            {}
          ]
        },
        "results_per_page": 10,
        "filters": [
          {
            "key": "category",
            "options_count": 10,
            "max_options_count": 10
          }
        ]
      }
    ]
  }
}'
  -H "Content-Type: application/json"
  -H "Authorization: Bearer {token}"

{
  "data": {
    "key": "afosto",
    "filters": {
      "show_for": "products",
      "sorting": [
        "category",
        "price"
      ],
      "options_count": 5,
      "max_options_count": 25
    },
    "is_autocomplete": null,
    "click_tracking": {
      "is_enabled": null
    },
    "indexes": [
      {
        "alias": "products",
        "template": {
          "name": null,
          "mapping": [
            {}
          ]
        },
        "results_per_page": 10,
        "filters": [
          {
            "key": "category",
            "options_count": 10,
            "max_options_count": 10
          }
        ]
      }
    ],
    "created_at": null,
    "updated_at": null
  },
  "page": {}
}

GET

/api/instant/proxies/{id}

View proxy

Path parameters

idstringRequired

Response body

keystring

The unique key of the proxy

filtersobject

is_autocompleteboolean

Whether or not this search engine is used as an autocomplete search

click_trackingobject

indexesarray[ProxyIndex]

created_atinteger

Format

int64

updated_atinteger

Format

int64

curl https://afosto.app/api/instant/proxies/{id} 
  -X GET 
  -H "Authorization: Bearer {token}"

{
  "data": {
    "key": "afosto",
    "filters": {
      "show_for": "products",
      "sorting": [
        "category",
        "price"
      ],
      "options_count": 5,
      "max_options_count": 25
    },
    "is_autocomplete": null,
    "click_tracking": {
      "is_enabled": null
    },
    "indexes": [
      {
        "alias": "products",
        "template": {
          "name": null,
          "mapping": [
            {}
          ]
        },
        "results_per_page": 10,
        "filters": [
          {
            "key": "category",
            "options_count": 10,
            "max_options_count": 10
          }
        ]
      }
    ],
    "created_at": null,
    "updated_at": null
  },
  "page": {}
}

PUT

/api/instant/proxies/{id}

Update proxy

Request body

filtersobject

is_autocompleteboolean

Whether or not this search engine is used as an autocomplete search

click_trackingobject

indexesarray[ProxyIndex]Required

Path parameters

idstringRequired

curl https://afosto.app/api/instant/proxies/{id} 
  -X PUT 
  -d '{
  "data": {
    "filters": {
      "show_for": "products",
      "sorting": [
        "category",
        "price"
      ],
      "options_count": 5,
      "max_options_count": 25
    },
    "is_autocomplete": null,
    "click_tracking": {
      "is_enabled": null
    },
    "indexes": [
      {
        "alias": "products",
        "template": {
          "name": null,
          "mapping": [
            {}
          ]
        },
        "results_per_page": 10,
        "filters": [
          {
            "key": "category",
            "options_count": 10,
            "max_options_count": 10
          }
        ]
      }
    ]
  }
}'
  -H "Content-Type: application/json"
  -H "Authorization: Bearer {token}"

DELETE

/api/instant/proxies/{id}

Delete proxy

Path parameters

idstringRequired

curl https://afosto.app/api/instant/proxies/{id} 
  -X DELETE 
  -H "Authorization: Bearer {token}"