View Macro

GET /macros/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/macros/{id}

Retrieves the details of a Macro

Rate limits:

Burst: 10/s
Steady: 150/m

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood 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

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ macros ]
An array of all created items.
Macro
Name
Description
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
deprecatedinteger
Describes if a macro is deprecated.


Example: 1

Possible values: 0 | 1
idstring
The ID of the macro, generated by Ocamba.


Example: 11
namestring
The name of the macro.


Example: OCMH_USER_ID
typestring
Describes the type of the macro.


Example: system

Possible values: system | dynamic
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the macro id, list the macros to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "11",
      "name": "OCMH_USER_ID",
      "deprecated": 1,
      "type": "system",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "11",
      "name": "OCMH_USER_ID",
      "deprecated": 1,
      "type": "system",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}