Jump to

• Request
• Response

Retrieve a list of keywords

get

/api/rest/2.0/assets/sms/keywords

Retrieves all Keyword that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
• lastUpdatedAt: integer
  The date and time the Keyword was last updated.
• orderBy: string
  Specifies the field by which list results are ordered.
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultKeyword

Type: object

Title: QueryResultKeyword

Show Source

• elements: array elements
  Array of keyword fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultKeyword",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of keyword fields.",
            "items":{
                "$ref":"#/definitions/KeywordRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of keyword fields.

Show Source

• Array of: object Keyword
  Title: Keyword

{
    "type":"array",
    "description":"Array of keyword fields.",
    "items":{
        "$ref":"#/definitions/KeywordRest20"
    }
}

Nested Schema : Keyword

Type: object

Title: Keyword

Show Source

• countryCodes: array countryCodes
  Countty codes associated with keyword.
• createdAt: string
  Read Only: true

  The date and time the keyword was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the keyword.
• currentStatus: string
  The keyword's current status. This is a read-only property.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the keyword.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the keyword.
• id: string
  Read Only: true

  Id of the keyword. This is a read-only property.
• keyword: string
  The name of the Keyword.
• keywordPosition: string
  Position of keyword.
• keywordType: string
  The type of the keyword.
• name: string
  The name of the keyword.
• permissions: array permissions
  The permissions for the keyword granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used.
• senderCodeId: integer
  Id of the associated sender code.
• sourceTemplateId: string
  Id of the template used to create the keyword.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the keyword was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the keyword.

{
    "title":"Keyword",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the keyword. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The keyword's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the keyword."
        },
        "description":{
            "type":"string",
            "description":"The description of the keyword."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the keyword granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the keyword."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the keyword."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the keyword."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the keyword was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the keyword."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the keyword was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "keyword":{
            "type":"string",
            "description":"The name of the Keyword."
        },
        "keywordType":{
            "type":"string",
            "description":"The type of the keyword."
        },
        "keywordPosition":{
            "type":"string",
            "description":"Position of keyword."
        },
        "senderCodeId":{
            "type":"integer",
            "description":"Id of the associated sender code."
        },
        "countryCodes":{
            "type":"array",
            "description":"Countty codes associated with keyword.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : countryCodes

Type: array

Countty codes associated with keyword.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Countty codes associated with keyword.",
    "items":{
        "type":"string"
    }
}

Nested Schema : permissions

Type: array

The permissions for the keyword granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the keyword granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top