campaigns

Detalhe de uma campanha com métricas

get/v1/campaigns/{id}

Path parameters

idstring uuid required

Response

Detalhe

idstring uuid required
namestring required
statusstring required
templateNamestring required
templateBodystring nullable
totalMessagesinteger required
sentCountinteger required
deliveredCountinteger required
readCountinteger required
clickedCountinteger required
convertedCountinteger required
convertedValuenumber float required
totalCostnumber float required
scheduledAtstring date-time nullable
startedAtstring date-time nullable
finishedAtstring date-time nullable
createdAtstring date-time nullable

Changes

Changed in 1 of the 4 revisions of this API.1422

  • 4e426b85f7841422See the full diff
    • the totalCost response's property type/format changed from number/decimal to number/float for status 200

      response-property-type-changed

    • removed the optional property failedMessages from the response with the 200 status

      response-optional-property-removed

    • removed the optional property internalId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property organizationId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property processedMessages from the response with the 200 status

      response-optional-property-removed

    • api tag campaigns added

      api-tag-added

    • api tag Campaigns removed

      api-tag-removed

    • added the media type application/json for the response with the status 404

      response-media-type-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • added the optional property createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property finishedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property scheduledAt to the response with the 200 status

      response-optional-property-added

    • added the optional property startedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property templateBody to the response with the 200 status

      response-optional-property-added

    • the response property id became required for the status 200

      response-property-became-required

    • the response property name became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property totalCost became required for the status 200

      response-property-became-required

    • the response property totalMessages became required for the status 200

      response-property-became-required

    • added the required property clickedCount to the response with the 200 status

      response-required-property-added

    • added the required property convertedCount to the response with the 200 status

      response-required-property-added

    • added the required property convertedValue to the response with the 200 status

      response-required-property-added

    • added the required property deliveredCount to the response with the 200 status

      response-required-property-added

    • added the required property readCount to the response with the 200 status

      response-required-property-added

    • added the required property sentCount to the response with the 200 status

      response-required-property-added

    • added the required property templateName to the response with the 200 status

      response-required-property-added

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog