Jump to

• Request
• Response

Get Open Engagements

get

/apis/customer-engagement-v1/utilities/{utilityCode}/engagements/opens

Returns a list of OPEN engagement events received for the specified utility within a specified date range, or empty response if no events found. NOTE: When startTime and endTime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended. Data returned will be greater than or equal to (>=) startTime and less than (<) endtime. < div>

Request

Path Parameters

• utilityCode(required): string
  A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util"

Query Parameters

• endTime:
  The optional upper bound on the date range (exclusive), as an ISO-8601 formatted string (e.g. '2018-02-19T13:00:00Z').
• offset:
  A positive integer indicating the starting offset of where to begin the list of engagements.
• startTime:
  The optional lower bound on the date range (inclusive) as an ISO-8601 formatted string (e.g. '2018-02-19T13:00:00Z').

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Events matching this query returned.

Body ()

Root Schema : OpenEngagementResponse

Type: object

Show Source

• engagements: array engagements
  A list of engagement events.
• page: object Page

{
    "type":"object",
    "properties":{
        "page":{
            "$ref":"#/definitions/Page"
        },
        "engagements":{
            "description":"A list of engagement events.",
            "type":"array",
            "example":{
                "id":"accf6a68-66c8-11e9-a923-1681be663d3e",
                "product":"HER",
                "communicationEventType":"HOME_ENERGY",
                "eventType":"OPEN",
                "trackId":"accf6cf2-66c8-11e9-a923-1681be663d3e",
                "campaignId":"accf6f22-66c8-11e9-a923-1681be663d3e",
                "moduleId":"accf7256-66c8-11e9-a923-1681be663d3e",
                "emailAddress":"86e0b9e56c17cc4d12387e1949b85053fbe73bc3ce5a1188713a9d300cc6133d",
                "occurredOn":"2018-02-19T13:01:00Z",
                "utilityCustomerId":"1872099045-387109999",
                "utilityInternalId":1872099045,
                "utilityInternalId2":"18720-99045",
                "customerMultitenantId":"util-1872099045-387109999",
                "communicationMultitenantId":"util-8-e89ade"
            },
            "items":{
                "$ref":"#/definitions/OpenEngagement"
            }
        }
    }
}

Nested Schema : engagements

Type: array

A list of engagement events.

Show Source

• Array of: object OpenEngagement

{
    "description":"A list of engagement events.",
    "type":"array",
    "example":{
        "id":"accf6a68-66c8-11e9-a923-1681be663d3e",
        "product":"HER",
        "communicationEventType":"HOME_ENERGY",
        "eventType":"OPEN",
        "trackId":"accf6cf2-66c8-11e9-a923-1681be663d3e",
        "campaignId":"accf6f22-66c8-11e9-a923-1681be663d3e",
        "moduleId":"accf7256-66c8-11e9-a923-1681be663d3e",
        "emailAddress":"86e0b9e56c17cc4d12387e1949b85053fbe73bc3ce5a1188713a9d300cc6133d",
        "occurredOn":"2018-02-19T13:01:00Z",
        "utilityCustomerId":"1872099045-387109999",
        "utilityInternalId":1872099045,
        "utilityInternalId2":"18720-99045",
        "customerMultitenantId":"util-1872099045-387109999",
        "communicationMultitenantId":"util-8-e89ade"
    },
    "items":{
        "$ref":"#/definitions/OpenEngagement"
    }
}

Example:

{
    "id":"accf6a68-66c8-11e9-a923-1681be663d3e",
    "product":"HER",
    "communicationEventType":"HOME_ENERGY",
    "eventType":"OPEN",
    "trackId":"accf6cf2-66c8-11e9-a923-1681be663d3e",
    "campaignId":"accf6f22-66c8-11e9-a923-1681be663d3e",
    "moduleId":"accf7256-66c8-11e9-a923-1681be663d3e",
    "emailAddress":"86e0b9e56c17cc4d12387e1949b85053fbe73bc3ce5a1188713a9d300cc6133d",
    "occurredOn":"2018-02-19T13:01:00Z",
    "utilityCustomerId":"1872099045-387109999",
    "utilityInternalId":1872099045,
    "utilityInternalId2":"18720-99045",
    "customerMultitenantId":"util-1872099045-387109999",
    "communicationMultitenantId":"util-8-e89ade"
}

Nested Schema : Page

Type: object

Show Source

• next: integer(int64)
  A positive integer indicating the starting offset for the next call, to get the next page.

{
    "type":"object",
    "properties":{
        "next":{
            "type":"integer",
            "format":"int64",
            "description":"A positive integer indicating the starting offset for the next call, to get the next page.\n"
        }
    }
}

Nested Schema : OpenEngagement

Type: object

Show Source

• campaignId: integer(int64)
  The ID that identifies the campaign which was used for communication experience
• communicationEventType: string
  The event for which the communication was done
• communicationMultitenantId: string
  The customer's communication unique multi-tenant UUID
• customerMultitenantId: string
  The customer???s globally unique multi-tenant UUID
• emailAddress: string
  The customer email address for which the communication was sent hashed in SHA-256 format
• eventType: string
  The event type of engagement: OPEN
• id: integer(int64)
• occurredOn: string(date-time)
  The instant in time when the event occurred
• product: string
  The product for which the communication was sent
• trackId: string
  The UUID that identifies the track which was used for communication experience
• utilityCustomerId: string
  The customer???s utility customer id
• utilityInternalId: string
  The customer???s utility internal id
• utilityInternalId2: string
  The customer???s secondary utility internal id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "product":{
            "type":"string",
            "description":"The product for which the communication was sent\n"
        },
        "communicationEventType":{
            "type":"string",
            "description":"The event for which the communication was done\n"
        },
        "eventType":{
            "type":"string",
            "description":"The event type of engagement: OPEN\n"
        },
        "trackId":{
            "type":"string",
            "description":"The UUID that identifies the track which was used for communication experience\n"
        },
        "campaignId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID that identifies the campaign which was used for communication experience\n"
        },
        "emailAddress":{
            "type":"string",
            "description":"The customer email address for which the communication was sent hashed in SHA-256 format\n"
        },
        "occurredOn":{
            "type":"string",
            "format":"date-time",
            "description":"The instant in time when the event occurred\n"
        },
        "utilityCustomerId":{
            "type":"string",
            "description":"The customer???s utility customer id\n"
        },
        "utilityInternalId":{
            "type":"string",
            "description":"The customer???s utility internal id\n"
        },
        "utilityInternalId2":{
            "type":"string",
            "description":"The customer???s secondary utility internal id\n"
        },
        "customerMultitenantId":{
            "type":"string",
            "description":"The customer???s globally unique multi-tenant UUID\n"
        },
        "communicationMultitenantId":{
            "type":"string",
            "description":"The customer's communication unique multi-tenant UUID\n"
        }
    }
}

400 Response

Invalid Request

403 Response

Unauthorized request

Back to Top