View Search algorithm

GET /search-algos/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/search-algos/{id}

Get an instance of algorithm.

path Parameters
Arrow
Name
Description
idstringrequired
Search algorithm id.


Example: 1000056
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10

Response status codes
Arrow
200 - OK
Arrow
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2023-06-07 06:53:29
descriptionstring
A more detailed description of the algorithm. Maximum 2000 characters.


Example: This is my first algorithm.
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000029
metadataobject

Name
Description
keystring
Key for the metadata.
Each key must be unique within the metadata object. Maximum 64 characters.


Example: key1
valuestring
Value for the metadata. Maximum 64 characters.


Example: value1
namestring
Name of the algorithm.


Example: example_campaign_algorithm
typestring
Campaign algorithm type.


Example: system

Possible values: system | custom
update_timestring
Timezone: GMT.


Example: 2024-06-06 06:53:29
tip
1 Searchable fields are name.
2 Sortable fields are name, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "1000024",
      "company_id": "6197120",
      "name": "my first algorithm",
      "description": "description",           
      "type": "custom",
      "metadata": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }       
      "create_time": "2024-06-18 07:40:33",
      "update_time": "2024-06-18 07:40:56"
    }
  ]
}


{
  "id": "1000029",
  "company_id": "7196310",
  "name": "example_campaign_algorithm",
  "description": "This is my first algorithm.",
  "type": "system",
  "metadata": {
    "key": "key1",
    "value": "value1"
  },
  "create_time": "2023-06-07 06:53:29",
  "update_time": "2024-06-06 06:53:29"
}