List Widgets

Copied

                https://api.ocamba.com/v2/adex/widgets

Returns a list of Widgets

query Parameters

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

viewstring

Adex API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Example: view=full/default

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

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

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

idstring

Unique identifier for the object defined as a query parameter.

Example: id=12345

Response status codes

200 - OK

Name

Description

items[ widget ]

An array of all created items.

Widget

Name

Description

contentstring

The widget content. This is the place where you can put HTML content with replacable fragments(macros). Where HTML page is rendered, placeholders are replaced with real macro values.

create_timedateTime

Timezone: GMT.

Example: 2021-09-29 15:40:10

idstring

The ID of the widget, generated by the Ocamba API

Example: 1000

macros[ widget-macro ]

The array of macro objects.

Macro

Name

Description

namestring

The macro name.

Example: TITLE

requirednumber (int)

Acceptable values are - 0/1.

Example: 1

typestring

At this time only text macros are supported.

Example: text

namestring

The widget name.

Example: My first widget

totalinteger

A total number of items.

Example: 38

tip

1 Searchable fields are name, and content.

2 Sortable fields are name, type, create_time and update_time.

3 Filterable fields are id, name, type, create_time and update_time.

4 To get the widget object, pass widget_id.

Response examples

Copied

200

{
  "total": 38,
  "items": [
    {
      "id": "143",
      "company_id": "3813298",
      "name": "ase",
      "type": "widget example 1",
      "create_time": "2023-04-25 06:45:34",
      "update_time": "2024-02-22 11:23:01"
    },
    {
      "id": "131",
      "company_id": "3813298",
      "name": "widget example 2",
      "type": "user-defined",
      "create_time": "2022-10-14 09:53:17",
      "update_time": "2024-02-21 14:52:25"
    }
  ]
}

{
  "total": 38,
  "items": [
    {
      "id": "1000",
      "name": "My first widget",
      "macros": [
        {
          "name": "TITLE",
          "type": "text",
          "required": 1
        }
      ],
      "create_time": "2021-09-29 15:40:10"
    }
  ]
}

List Widgets

GET /widgetsCopied https://api.ocamba.com/v2/adex/widgets

GET /widgets
Copied
`https://api.ocamba.com/v2/adex/widgets`