Skip to main content
POST
/
partner
/
deliverableReport
Get deliverable detail report data
curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/partner/deliverableReport \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_filter_range": "last_month",
  "job_id": 100,
  "athlete_id": 200,
  "deliverable_id": 300,
  "sort_column": "deal_id",
  "sort_order": "DESC",
  "timezone_diff": -5,
  "page": 1,
  "limit": 10,
  "page_limit": 25,
  "filter": []
}
'
{
  "status": "success",
  "message": "data found",
  "data": []
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Use the /api/login endpoint to obtain a token.

Body

application/json
​
date_filter_range
string

Date range filter. Predefined: last_month, last_week, this_week, All. Or custom range as 'YYYY/MM/DD-YYYY/MM/DD'

Example:

"last_month"

​
job_id
integer | null

Filter by specific job/deal ID

Example:

100

​
athlete_id
integer | null

Filter by specific athlete ID

Example:

200

​
deliverable_id
integer | null

Filter by milestone template ID (milestones.id)

Example:

300

​
sort_column
enum<string> | null

Column key to sort by

Available options:
deal_id,
deal_name,
category,
athlete_name,
hire_date,
deal_completion_date,
deliverable_id,
deliverable_number,
deliverable_type,
due_date,
submitted,
submitted_date,
approved,
approval_date,
preview,
proof_of_work,
cost,
cpm,
impressions,
cpe,
total_engagements,
engagement_rate,
comments,
likes,
shares,
bookmarks,
retweets,
last_date_refresh
Example:

"deal_id"

​
sort_order
enum<string> | null

Sort direction

Available options:
asc,
desc,
ASC,
DESC
Example:

"DESC"

​
timezone_diff
number<float> | null

Timezone offset in decimal hours from UTC (e.g. -5.5 for EST)

Example:

-5

​
page
integer | null

Page number

Example:

1

​
limit
integer | null

Items per page (default 10)

Example:

10

​
page_limit
integer | null

Alias for limit (takes priority over limit if both sent)

Example:

25

​
filter
object

Column-level filters object. Keys are column names, values are filter objects.

Example:
[]

Response

200 - application/json

Deliverable report data

​
status
string
Example:

"success"

​
message
string
Example:

"data found"

​
data
object
Example:
[]