Newgrounds.io Object Models

exec_time — string
The time, in milliseconds, that it took to execute a request.

request — Request object
A copy of the request object that was posted to the server.

code — int
A code indicating the error type.

message — string
Contains details about the error.

component* — string
The name of the component you want to call, ie 'App.connect'.
(Only required if 'secure' is not set.)

echo — mixed
An optional value that will be returned, verbatim, in the Result object.

parameters — object or array of objects
An object of parameters you want to pass to the component.
(Only used if 'secure' is not set.)

secure* — string
A an encrypted Execute object or array of Execute objects.
(Only required if 'component' is not set.)

* Required property

description — string
A short description of the medal.

difficulty — int
The difficulty id of the medal: 1 = easy, 2 = moderate, 3 = challenging, 4 = difficult, 5 = brutal.

icon — string
The URL for the medal's icon (typically a webp file).

id — int
The numeric ID of the medal.

name — string
The name of the medal.

secret — boolean

unlocked — boolean
This will only be set if a valid session_id exists in the request object.

value — int
The medal's point value.

app_id* — string
Your application's unique ID.

debug — boolean
If set to true, calls will be executed in debug mode.

echo — mixed
An optional value that will be returned, verbatim, in the Response object.

execute* — Execute object or array of Execute objects
A Execute object, or array of one-or-more Execute objects.

session_id — string
An optional login session id. Components that save and unlock things to a user account will require this.

* Required property

api_version — string
If there was an error, this will contain the current version number of the API gateway.

app_id — string
Your application's unique ID

debug — Debug object
Contains extra information you may need when debugging (debug mode only).

echo — mixed
If you passed an 'echo' value in your request object, it will be echoed here.

error — Error object
This will contain any error info if the success property is false.

result — Result object or array of Result objects
This will be a Result object, or an array containing one-or-more Result objects (this will match the structure of the execute property in your Request object).

success — boolean
If false, there was a problem with your 'request' object. Details will be in the error property.

component — string
The name of the component that was executed (ie 'Medal.unlock').

data — object or array of objects
An object, or array of objects containing the result properties for the executed component.

echo — mixed
If you passed an 'echo' value in your execute object, it will be echoed here.

error — Error object
This will contain any error info if the success property is false.

success — boolean
If false, there was a problem with your 'request' object. Details will be in the error property.

datetime — string
A date and time (in ISO 8601 format) representing when this slot was last saved.

id — int
The slot number.

size — int
The size of the save data in bytes.

timestamp — int
A unix timestamp representing when this slot was last saved.

url — string
The URL containing the actual save data for this slot, or null if this slot has no data.

formatted_value — string
The score value in the format selected in your scoreboard settings.

tag — string
The tag attached to this score (if any).

user — User object
The user who earned this score. If this property is absent, the score belongs to the active user.

value — int
The integer value of the score.

id — int
The numeric ID of the scoreboard.

name — string
The name of the scoreboard.

expired — boolean
If true, the session_id is expired. Use App.startSession to get a new one.

id — string
A unique session identifier

passport_url — string
If the session has no associated user but is not expired, this property will provide a URL that can be used to sign the user in.

remember — boolean
If true, the user would like you to remember their session id.

user — User object
If the user has not signed in, or granted access to your app, this will be null

id — int
The user's numeric ID.

name — string
The user's textual name.

supporter — boolean
Returns true if the user currently has a Newgrounds Supporter upgrade.

url — string
The URL to the user's profile.