Bulk Activity - Status Report Endpoint

Use this endpoint to generate a report showing the status of the last 50 bulk activities.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: contacts:write OR contacts:read

Retrieve a summary status report of the last 50 activities submitted. Individual activities are stored for 14 days.

You can filter the response as follows:

  • by type
  • by status
  • by both status and type

GET: https://api.constantcontact.com/v2/activities

name

type

default

description

api_key

query

REQUIRED; The API key for the application

status

query

ALL

Retrieve all activities with the specified status, valid values are:

  • ALL (default)
  • UNCONFIRMED
  • PENDING
  • QUEUED
  • RUNNING
  • COMPLETE
  • ERROR

type

query

Retrieve all activities of the type specified; valid values are:

  • ADD_CONTACTS
  • REMOVE_CONTACTS_FROM_LISTS
  • CLEAR_CONTACTS_FROM_LISTS
  • EXPORT_CONTACTS

Response CodesTOP

code

description

200

Request was successful

400

Bad Request; Error in validating a contact

401

Authentication failure

500

Internal server error occurred

StructureTOP

property

type(max length)

description

contact_count

integer

Number of contacts processed in the activity

created_date

string

Date and time that the activity was created once it was picked and placed in the queue, in ISO 8601 format

error_count

integer

Number of errors encountered during the activity

finish_date

string

Date and time that activity was completed, in ISO 8601 format

id

string

Unique ID for the activity

start_date

string

Date and time that the API started processing the activity, in ISO-8601 format

status

string

The status of the activity, valid values are:

  • UNCONFIRMED
  • PENDING - initial state for an activity after it is created
  • QUEUED - the activity has been retrieved and is in the queue to be run
  • RUNNING - the activity has been picked up from the queue and is running
  • COMPLETE - the activity has completed without errors
  • ERROR - errors occurred while running the job

type

string

Type of activity, valid values are:

  • ADD_CONTACTS - add the contacts to contact list(s) specified in the import file
  • CLEAR_CONTACTS_FROM_LISTS - removes all contacts from the contactlist(s) specified in the import file
  • EXPORT_CONTACTS - export contacts to a supported file type
  • REMOVE_CONTACTS_FROM_LISTS - remove the contacts from the list(s), all specified in the import file

Example ResponseTOP

[
	{
	"id": "a07e1ilbm7shdg6ikeo",
	"type": "REMOVE_CONTACTS_FROM_LISTS",
	"status": "COMPLETE",
	"start_date": "2013-02-21T17:23:09.812Z",
	"finish_date": "2013-02-21T17:23:09.837Z",
	"created_date": "2013-02-21T17:22:42.768Z",
	"error_count": 3,
	"contact_count": 3
	},
	{
	"id": "a07e1ilbm6uhdg5w1lu",
	"type": "REMOVE_CONTACTS_FROM_LISTS",
	"status": "COMPLETE",
	"start_date": "2013-02-21T17:06:11.800Z",
	"finish_date": "2013-02-21T17:06:11.849Z",
	"created_date": "2013-02-21T17:05:11.970Z",
	"error_count": 3,
	"contact_count": 3
	},
	{
	"id": "a07e1ilba2lhdf22eqb",
	"type": "EXPORT_CONTACTS",
	"status": "COMPLETE",
	"start_date": "2013-02-20T22:30:55.945Z",
	"finish_date": "2013-02-20T22:31:18.603Z",
	"created_date": "2013-02-20T22:30:24.275Z",
	"error_count": 0,
	"contact_count": 71296
	}
]