Need Help?

Analytics API Error Codes

Last Updated: Oct 30, 2015
This page lists most of the possible error codes that can be returned by the Luminoso Analytics API, along with their corresponding messages and the situations in which they occur. (There are a few other error codes that are not listed because it is unlikely that they would ever occur in practice.)


Authentication

AUTH_MALFORMED

Message: User credentials missing from login request.

Either the "username" or the "password" parameter was not included in the form data posted to the login endpoint.

AUTH_CREDS_INVALID

Message: User credentials invalid (incorrect username and/or password).

The username or password was incorrect when trying to log in or change your password.

SIG_EXPIRED

Message: Signature has expired.

The expiration specified in the request has passed. Expirations are used in cases where a person receives an email that needs to be acted on within a set amount of time, such as accepting an invitation to an account, or resetting your password.

SIG_INVALID

Message: Signature didn't match the request contents.

The signature specified on the request was not what it should have been given the request contents. Signatures are used for verifying parameters that come from email links (see SIG_EXPIRED above).


Token Authentication

NO_TOKEN

Message: No authorization token was provided.

No token was provided in the "Authorization" header of the request. Refer to the API Guide for an explanation of token authentication.

INVALID_TOKEN

Message: That token (<token>) does not exist.

A token doesn't exist (possibly it used to exist but has since expired); this can refer either to the token that was specified in the auth header or, for the /user/tokens/<token>/ endpoint, the token that was trying to be retrieved/deleted.

TOKEN_LIMIT

Message: Each user can only have one long-lived token at a time.

You tried to create a long-lived token but you already have one.

INVALID_TOKEN_DELETE

Message: A token cannot be used to authenticate its own deletion using this endpoint.

You tried to delete a token using the /user/tokens/<token>/ endpoint, but the request was authenticated with the token trying to be deleted. To delete a short-lived token, POST /user/logout/ should be used; to delete a long-lived token, you must authenticate using a short-lived token.


Authorization

ERR_UNAUTH

Message: You don't have <permission-level> permission on that resource (<resource>).

You tried to do something you are not allowed to do (for example, modify a project that you don't have "write" permission on, view an account that you don't have "read" permission on, etc.). It is possible that the reason you don't have permission on the resource is that it doesn't exist, so if you think it's something you should have permission on, check that you typed it correctly.

USER_EXISTS

Message: A user with that username (<username>) already exists.

There already exists a user with the same username (email address) as the one you are trying to create.

USER_HAS_ACCESS

Message: That user (<username>) already has permissions on that account (<account>).

You tried to invite some user to join an account, but the user already has permission on the account. To modify an existing user's permissions on an account, use PUT /accounts//users/<email>/permissions/. 

GROUP_HAS_ACCESS

Message: That group (<group>) already has permissions on that resource (<resource>).

You tried to grant a sharing group permission on something it already has permission on.

INVALID_ACCOUNT

Message: No account with that ID (<account>) exists.

You tried to do something to an account (for example, set it as your default account) that doesn't exist (or that you don't have permission on).

INVALID_GROUP

Message: No group with that name (<group>) exists.

You tried to do something to a sharing group that doesn't exist (or that you don't have permission on).
 


Type of input

BAD_CONTENT_TYPE

Message: That content type (<content_type>) is not supported.

For example, you tried to upload documents but the content-type was not specified to be JSON.

JSON_UNREADABLE

Message: We were unable to decode the contents of the parameter <parameter>.

A request parameter was supposed to be JSON but was not valid JSON. Note that all request parameters that aren't numbers or strings (i.e., parameters that are lists, dictionaries, or booleans) should be JSON-encoded.

NOT_A_DICT_LIST

Message: The parameter <parameter> should be a list of dictionaries.

NOT_A_STR_LIST

Message: The parameter <parameter> should be a list of strings.

NOT_A_DICT

Message: The parameter <parameter> should be a single dictionary.

NOT_A_NUM

Message: The parameter <parameter> should be a number.


Expected/unexpected inputs

UNEXPECTED_PARAM

Message: The command received an unexpected parameter (<parameter>).

PARAM_INVALID

Message: An invalid value (<value>) was supplied for a parameter (<parameter>).

For example, the parameter's value was a number that was larger than the maximum allowed.

PARAM_MISSING

Message: A required parameter (<parameter>) was missing from your call.


State of project

NOT_WRITEABLE

Message: This version of the database cannot be modified.

There is a storage format change in progress and this project has not been transitioned yet. You should wait a while (on the order of hours) and try again. This should never happen in production, because projects visible on production should have already been transitioned.

NO_OBJ

Message: That <resource-type> (<ID>) does not seem to exist.

You tried to access some object (such as a project, dashboard, worksheet, or widget) that doesn't exist (or that you don't have permission on).

NO_TOPIC

Message: That topic (<topic-id>) does not seem to exist.

NO_DOC

Message: That document (<document-id>) was not found in the database.

NO_ASSOC

Message: That command will not work until the project has been fully built.

The project is currently building or rebuilding. Wait until it's done.

NO_DATES

Message: The project does not contain any documents with timestamps.

You tried to get topic timeline correlations for a project that doesn't actually have any time information.  See the Document Fields page for how to specify dates.
 

DB_BUSY

Message: The project is currently being modified. Please try again later.

You tried to do something to the project while someone else was modifying its documents (adding, removing, etc). This should not happen very often, because modifying documents doesn't take very long; if it happens, just try again.

BROKEN_PROJECT

Message: A serious error has occurred in this project. Please contact Luminoso for technical assistance.


Jobs

JOB_UNKNOWN

Message: That doesn't seem to be a known job number (<job-id>).

JOB_RUNNING

Message: There is another job (<job-id>) currently running. Please try again when it has finished.

You can only run one job (rebuilding the project or training the predictors) at a time.

External services

EMAIL_ERROR

Message: There was an error sending the email.

MAX_EMAILS

Message: The maximum number of emails of that type (<email-type>) have already been sent to that address in the past 24 hours.

Our system limits the number of emails that it will send to any email address per day; this is primarily for the sake of password-recovery, which sends an email without requiring you to be logged in, and we don't want people to be able to use this to spam other people with password-recovery emails.

HTTP errors

NOT_FOUND

Message: That endpoint (<path>) does not seem to exist.

INVALID_HTTP_METHOD

Message: The method you tried is not allowed for that endpoint.

For example, POSTing to an endpoint that only allows GET.

POST_TO_PROJECTS

Message: POST does not work for the /projects/ endpoint. Perhaps you meant to POST to /projects/<account>/?


Miscellaneous

ERROR

Message: There was an error.
Some unexpected internal server error occurred.

More Support

6560c840000970c2e652c21ccafb3167@luminoso.desk-mail.com
http://assets1.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete