List Export

This service is for creating and alteration of list exports.

NB: Unless you need to specifically keep a created List Export in the system, please remove them once you've downloaded and are happy with the result of your export.


insert

int list_export.insert( array data )

Create a new list export for a given list.

Parameters

data

Name

Required

Type

Description

list_id

yes

int

The Id of list from which you want to create the export

name

yes

string

What you want to name the report

fields

yes

array

Indexed array of profile field IDs

Return Values

Returns an int type. The Id of the newly created list export.

This will be made available for download once complete - you can check the status through #getProgress

The file can then be downloaded by using the following URL:

https://<server>/download/listexport/id/<id>

Where:

Placeholder

Value

server

Hostname of your server

id

The list export Id returned



update

bool list_export.update( int exportId, array data )

Updates an existing list export using the data specified.

Parameters

exportId

ID of the list export you want to update.

data

See #insert for the elements that can be written. All keys are optional.

Return Values

Returns a bool. True on success.



delete

bool list_export.delete( int exportId )

Deletes the specified list export.

Parameters

exportId

ID of the list export you want to delete.

Return Values

Returns true on success, false on failure.



getProgress

bool list_export.getProgress( int exportId )

Get the progress on the list export generation.

Parameters

exportId

ID of the list export for which you want to see the progress.

Return Values

Returns an associative array. The possible returned elements are as follows:

Name

Type

Description

percentage

int

Percentage complete

status

string

The status helps indicate at which point in export is within the process.

Service

list_export

Methods