Home

CityGrid Advertising APIs

Skip to end of metadata
Go to start of metadata

Introduction

Icon

This is documentation for the v3 endpoint, if you are looking for the previous v2 version see here

 

The CityGrid Call Detail Reporting API is part of the Advertising API suite and generates a list of phone calls tracked by the metered phone lines for a particular campaign

Contents

Call Detail Report Endpoint

The Call Detail Report endpoint returns a paginated list of phone calls. The operation is invoked via HTTPS GET to:

Request Parameters

Parameter

Description

Required

Type

Default

Example

campaignId

The Campaign ID for lookup

Yes

Long

N/A

2605

period

Date range for the report (case sensitive). Cannot be used with startDate and endDate.

No

yesterday
last7Days
last14Days
last30Days
lastWeek
lastBusinessWeek
thisMonth
lastMonth
billing1
billing2
billing3

yesterday

last7Days

startDate

Start date (inclusive) for the report date range to query.

Yes if endDate is used.

Date (formatted as MM-DD-YYYY)

N/A

01-15-2018

endDate

End date (inclusive) for the report date range to query.

Yes if startDate is used.

Date (formatted as MM-DD-YYYY)

N/A

02-15-2018

startIndexPage number of results to return (zero-based)NoInteger02
numberResultsNumber of results per pageNoInteger10050
Icon

billing1 refers to the most recent billing cycle, billing2 to the billing cycle just before billing1, and billing3 to the billing cycle just preceding billing2.

Request Header Values

Header

Description

Required

Valid Values

Accept

Requested format for the response

Yes

application/json

authToken

Authentication Token from the Call Detail Reporting API

Yes

Valid token

Request Examples

Example 1: Request the call details from the last 14 days for the campaign 2605
Example 2: Request the call details for 01-15-2018 (inclusive) to 02-15-2018 (inclusive).

Response Properties

Property

Type

Description

totalNumEntries

Integer

Total number of results

callDetails

List

Top-level element for results

placeIdLongID of the Place that received the call

callId

String

Unique ID for the call

startTime

String

The start date and time of the call in ISO 8601 format with the offset given in hours (no minutes and seconds). Examples:
2012-03-09T18:58:21-08
2012-03-12T11:12:55-07

duration

Integer

The length of the call in seconds

providerPhone

String

The "ring to" phone number for the merchant

displayPhone

String

The CityGrid metered line

callerPhone

String

The caller's phone number

audioUrl

String

URL to access call recording if one is available

callCompletionCode

{Normal, Busy, Missed}

How the call was completed.

isBillable{0, 1}Whether or not the call is billable

response

Response Metadata

(See complete response descriptions)

Response Examples

JSON Success Response
JSON Error Response

A request for the following (note "Last14Dayz" instead of the required "last14Days")

  • No labels