Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Log

Create a new log.

Create a new log.

post/cm/v1/logs

Query parameters

ad_account_idstring required

Ad account ID to which a log associated.

Request body

idstring

Unique identifier of the Log. Automatically set by server on creation.

type'UNKNOWN_LOG_TYPE' | 'IMP' | 'CLICK' | 'CONVERSION' | 'SKAN_CONVERSION' | 'ENGAGED_VIEW' required

Type enumerates available log types.

Unknown log type.

  • IMP: Log type which includes every impression log.
  • CLICK: Log type which includes every click log.
  • CONVERSION: Log type which includes every conversion event log.
  • SKAN_CONVERSION: Log type which includes SKAdNetwork attributed conversion event log.
  • ENGAGED_VIEW: Log type which includes every engaged view log.
format'UNKNOWN_LOG_FORMAT' | 'CSV' | 'AVRO' | 'PARQUET'

Format enumerates the format of log. Default is CSV.

  • CSV: CSV format.
  • AVRO: Avro format.
  • PARQUET: Parquet format.
datestring required

Date for which a log contains the data in "yyyy-mm-dd" format.

ad_account_idstring required

Ad account ID to which the log is bound.

status'UNKNOWN_LOG_STATUS' | 'ACCEPTED' | 'READY' | 'FAILED'

Status enumerates the status of log.

  • ACCEPTED: Successfully initiated the log generation request.
  • READY: Successfully generated the log. It's ready to download from the location.
  • FAILED: Failed to generate the log. Reasons of failure can be found at errors.
skip_compressionboolean

Flag whether to skip compression.

expire_atstring date-time

The time when a log will be expired.

created_atstring date-time

Created time.

updated_atstring date-time

Last updated time. Should not modify on the client side.

Example request

{
  "id": "sampleLogId",
  "ad_account_id": "sampleAdAccountId",
  "type": "IMP",
  "format": "CSV",
  "date": "2020-01-01",
  "created_at": "2020-01-03T03:12:50.124101982Z",
  "updated_at": "2020-01-03T03:24:21.109821241Z"
}

Response

A successful response.

hrefstring

Reference URL that shows the log.

statusstring

Reference URL that shows the most recent status of the log.

Example response

{
  "log": {
    "id": "newlyCreatedLogId",
    "ad_account_id": "sampleAdAccountId",
    "type": "IMP",
    "format": "CSV",
    "date": "2020-01-01",
    "created_at": "2020-01-01T03:12:50.124101982Z",
    "updated_at": "2020-01-01T03:12:50.124101982Z"
  },
  "href": "https://managefnt.adsmoloco.com/cm/v1/logs/newlyCreatedLogId",
  "status": "https://managefnt.adsmoloco.com/cm/v1/logs/newlyCreatedLogId/status"
}