Skip to main content Link Search Menu Expand Document (external link)

Updated Thu Sep 22nd 2022, 19:00 UTC

Recurring Instances

GET /campaigns/:campaign/recurring_instances

Returns a collection of campaigns that have been sent or scheduled by a recurring campaign

Examples

Get Recurring Instances

Request

GET /campaigns/bK9DjpX/recurring_instances
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /campaigns/bK9DjpX/recurring_instances
    

Response

Status

200

Response Type

hydra:Collection

Example Body

{
  "@type": "hydra:Collection",
  "@context": "/contexts/hydra:Collection.jsonld",
  "id": "/campaigns/bK9DjpX/recurring_instances",
  "members": [
    {
      "@type": "Campaign",
      "@context": "/contexts/Campaign.jsonld",
      "id": "/campaigns/joOQd57",
      "title": "The Best Campaign",
      "messageBody": "The best campaign message.",
      "state": "sent",
      "type": "single",
      "schedule": "FREQ=DAILY;BYHOUR=15;BYMINUTE=3",
      "createdAt": "2018-11-19T20:51:54.000Z",
      "scheduledAt": "2018-11-19T21:00:54.000Z",
      "sendingStartAt": null,
      "sendingEndAt": null,
      "estimatedStartAt": null,
      "estimatedFinishAt": null,
      "deliveryStatistics": {
        "total": 0,
        "skipped": 0,
        "sent": 0,
        "delivered": 0,
        "replied": 0,
        "unreplied": 0,
        "failed": 0
      },
      "campaignTemplates": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/campaigns/joOQd57/templates",
        "members": [
          {
            "@type": "CampaignTemplate",
            "@context": "/contexts/CampaignTemplate.jsonld",
            "id": "/campaigns/joOQd57/templates/BYoaNE",
            "sortOrder": 1,
            "messageBody": "hi",
            "attachments": {
              "@type": "hydra:Collection",
              "@context": "/contexts/hydra:Collection.jsonld",
              "id": "/campaigns/AJoOVb7/campaign_attachments",
              "members": [
                {
                  "@type": "Attachment",
                  "@context": "/contexts/Attachment.jsonld",
                  "id": "/campaign_attachments/7LdVlM",
                  "url": "https://foo.cloudfront.net/bar1234=",
                  "downloadUrl": "https://s3.amazonaws.com/attachments",
                  "key": "abc123.png",
                  "contentType": "image/png",
                  "size": 6829,
                  "width": 101,
                  "height": 128,
                  "originalFilename": "original"
                }
              ],
              "totalItems": 1
            },
            "registeredLinks": {
              "@type": "hydra:Collection",
              "@context": "/contexts/hydra:Collection.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
              "members": [
                {
                  "@type": "CampaignRegisteredLink",
                  "@context": "/contexts/CampaignRegisteredLink.jsonld",
                  "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
                  "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
                  "originalLink": "https://xkcd.com",
                  "clickCount": 9
                }
              ],
              "totalItems": 1
            },
            "deliveryStatistics": {
              "total": 1,
              "skipped": 0,
              "sent": 1,
              "delivered": 1,
              "replied": 0,
              "unreplied": 1,
              "failed": 0
            },
            "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
            "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
            "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
            "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
            "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
            "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
            "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
          }
        ],
        "totalItems": 1
      },
      "delete": "/campaigns/joOQd57",
      "edit": "/campaigns/joOQd57",
      "cancel": "/campaigns/joOQd57/cancel",
      "account": "/accounts/my_account",
      "group": "/groups/3D6ZO7",
      "user": {
        "@type": "User",
        "@context": "/contexts/User.jsonld",
        "id": "/users/wqyODPA",
        "name": "Chuck Norris",
        "firstName": "Chuck",
        "lastName": "Norris",
        "email": "chuck@textus.example",
        "avatar": null,
        "automatedActor": false,
        "hasPassword": false,
        "discarded": false,
        "settings": {
          "customSettings": {}
        },
        "memberships": "/users/wqyODPA/memberships"
      },
      "totalRecipients": "/campaigns/nGJ2ge3/campaign_recipients/total",
      "skippedRecipients": "/campaigns/nGJ2ge3/campaign_recipients/skipped",
      "sentRecipients": "/campaigns/nGJ2ge3/campaign_recipients/sent",
      "deliveredRecipients": "/campaigns/nGJ2ge3/campaign_recipients/delivered",
      "repliedRecipients": "/campaigns/nGJ2ge3/campaign_recipients/replied",
      "unrepliedRecipients": "/campaigns/nGJ2ge3/campaign_recipients/unreplied",
      "failedRecipients": "/campaigns/nGJ2ge3/campaign_recipients/failed",
      "lastSentAt": null,
      "attachments": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/campaigns/AJoOVb7/campaign_attachments",
        "members": [],
        "totalItems": 0
      }
    }
  ],
  "totalItems": 1,
  "view": {
    "@type": "hydra:PartialCollectionView",
    "@context": "/contexts/hydra:PartialCollectionView.jsonld",
    "id": "/campaigns/bK9DjpX/recurring_instances",
    "first": "/campaigns/bK9DjpX/recurring_instances",
    "next": null,
    "previous": null
  }
}

© 2022 TextUs