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: 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
, andcomplete
. Any other values passed are reset tominimal
by default. -
isCertificateProvisioned: 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: integer
The date and time the microsite 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.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : QueryResultMicrosite
Type:
object
Title:
Show Source
QueryResultMicrosite
-
elements:
array elements
Array of microsite 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.
Nested Schema : elements
Type:
array
Array of microsite fields.
Show Source
-
Array of:
object Microsite
Title:
Microsite
Nested Schema : Microsite
Type:
object
Title:
Show Source
Microsite
-
createdAt:
string
Read Only:
true
The date and time the microsite was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the microsite. -
currentStatus:
string
The campaign's current status.
-
defaultLandingPageId:
string
The id for the associated default landing page.
-
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
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the microsite.
-
domains:
array domains
A collection of associated sub domains.
-
id:
string
Read Only:
true
Id of the microsite. This is a read-only property. -
isAllowedInFrame:
string
Whether pages associated to the microsite can be embedded within frames, iframes, or objects. Learn more.
-
name:
string
The name of the microsite.
-
permissions:
string
The permissions for the microsite granted to your current instance. This is a read-only property.
-
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 microsite was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the microsite.
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
}