« Back to Documentation Overview

get_import_stats

Section: Imports
Version: 1.5.0


Get statistics of import using IMPORT_ID.
Hint: Finished import should match equation: uploaded - already_in_queue - blacklists - invalid_domains - policy_failures - syntax_errors = inserts + replaces + updates.
Hint: Duplicated email address within single import will be counted as already_in_queue.


Parameters
stringAPI_KEY
object
stringimportIMPORT_ID
Return Value
integeruploaded32
integeralready_in_queue8
integerblacklists2
integerinvalid_domains1
integerpolicy_failures4
integersyntax_errors1
objectactions
integerinserts32
integerreplacesget_import_stats_replaces_0_integer
integerupdates16

Example Request JSON

[
    "API_KEY",
    {
        "import": "IMPORT_ID"
    }
]

Example Response JSON

{
    "uploaded": 32,
    "already_in_queue": 8,
    "blacklists": 2,
    "invalid_domains": 1,
    "policy_failures": 4,
    "syntax_errors": 1,
    "actions": {
        "inserts": 32,
        "replaces": 0,
        "updates": 16
    }
}

Example Error Response JSON

{
    "code": -1,
    "message": "Missing import"
}
Method-specific Errors
Missing import
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash