REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of microsites

get

/api/REST/1.0/assets/microsites

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

Request

Supported Media Types

application/json

Query Parameters

count(optional): integer

Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
depth(optional): 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.
isCertificateProvisioned(optional): string

Boolean query parameter to filter microsites provisioned using the Automated Certificate Management system. For example, ?isCertificateProvisioned=true. Set to false by default. For more information about Automated Certificate Management, refer to the help center.
lastUpdatedAt(optional): integer

The date and time the microsite was last updated.
orderBy(optional): string

Specifies the field by which list results are ordered.
page(optional): 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(optional): string

Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : QueryResultMicrosite

Type: object

Title: QueryResultMicrosite

Show Source

elements(optional): array elements

Array of microsite fields.
page(optional): integer

The specified page.
pageSize(optional): integer

The page size.
total(optional): integer

The total amount of results.
type(optional): string

The asset's type in Eloqua.

{
    "title":"QueryResultMicrosite",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of microsite fields.",
            "items":{
                "$ref":"#/definitions/MicrositeRest10"
            }
        },
        "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 microsite fields.

Show Source

Array of: object Microsite

Title: Microsite

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

Nested Schema : Microsite

Type: object

Title: Microsite

Show Source

createdAt(optional): string

Read Only: true

The date and time the microsite was created, expressed in Unix time.
createdBy(optional): string

Read Only: true

The login id of the user who created the microsite.
currentStatus(optional): string

The campaign's current status.
defaultLandingPageId(optional): string

The id for the associated default landing page.
depth(optional): 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(optional): string

The description of the microsite.
domains(optional): array domains

A collection of associated sub domains.
id(optional): string

Read Only: true

Id of the microsite. This is a read-only property.
isAllowedInFrame(optional): string

Whether pages associated to the microsite can be embedded within frames, iframes, or objects. Learn more.
name(optional): string

The name of the microsite.
permissions(optional): string

The permissions for the microsite granted to your current instance. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the microsite was last updated.
updatedBy(optional): string

Read Only: true

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

{
    "title":"Microsite",
    "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 microsite. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the microsite."
        },
        "description":{
            "type":"string",
            "description":"The description of the microsite."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the microsite granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the microsite."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the microsite was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the microsite."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the microsite was last updated."
        },
        "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>."
        },
        "domains":{
            "type":"array",
            "description":"A collection of associated sub domains.",
            "items":{
                "type":"string"
            }
        },
        "defaultLandingPageId":{
            "type":"string",
            "description":"The id for the associated default landing page."
        },
        "isAllowedInFrame":{
            "type":"string",
            "description":"Whether pages associated to the microsite can be embedded within frames, iframes, or objects. <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/index.html#CSHID=PreventEmbedding'>Learn more</a>."
        }
    }
}

Nested Schema : domains

Type: array

A collection of associated sub domains.

Show Source

Array of: string

{
    "type":"array",
    "description":"A collection of associated sub domains.",
    "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.

Examples

Retrieve the first 2 microsites in your database:


GET /api/REST/1.0/assets/microsites?count=2

Response:


{
    "elements":[
        {
            "type":"Microsite",
            "id":"1",
            "createdAt":"1208973099",
            "depth":"minimal",
            "name":"Your First Hypersite",
            "updatedAt":"1402929830",
            "updatedBy":"10"
        },
        {
            "type":"Microsite",
            "id":"2",
            "createdAt":"1402929830",
            "depth":"minimal",
            "name":"Confirmation Pages",
            "updatedAt":"1402929830"
        }
    ],
    "page":1,
    "pageSize":1000,
    "total":2
}