disableBatchPublicUrl

Disables report sharing for a batch.

disableBatchPublicUrl

Disables report sharing for a batch.

Top ↑

Syntax

bool disableBatchPublicUrl( string api_key, int batch_id );

Parameters

api_key (string)

The key required to access the API. See Getting Started for more information.

batch_id (int)

The ID of the Batch.

Return Value

Boolean

Examples

$batch_id = 1234567;

$api                    = new Api($url, 'YOURAPIKEY');
$report_disable_sharing = $api->invokeMethod('disableBatchPublicUrl', $batch_id);
{
    "id": 1,
    "method": "disableBatchPublicUrl",
    "params": [
        "YOURAPIKEY",
        1234567
    ]
}
  {
      "id":1,
      "result":true,
      "error":null
  }

Error Codes

This method may return the following error code in addition to the standard error codes:

Code Error Description
308 Unable to load Batch The system could not load batch_id.

See Also